diff --git a/site/specs-temp/numbers.json b/site/specs-temp/numbers.json index 1611db82a..8839c5adc 100644 --- a/site/specs-temp/numbers.json +++ b/site/specs-temp/numbers.json @@ -3098,7 +3098,7 @@ "/accounts/{accountId}/discnumbers": { "get": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Retrieves a list of disconnected numbers associated with the account. There are optional search parameters to limit the discNumbers payload", "operationId": "GetDisconnectedTns", @@ -3171,7 +3171,7 @@ "/accounts/{accountId}/discnumbers/totals": { "get": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Retrieves a total number of disconnects.", "operationId": "GetTotalNumberDisconnects", @@ -3223,7 +3223,7 @@ "/accounts/{accountId}/disconnects": { "get": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Retrieve a list of disconnect orders that is associated with an account.\nPlease visit Guides and Tutorials", "summary": "Read disconnect orders", @@ -3330,7 +3330,7 @@ "post": { "description": "Use this method to disconnect telephone numbers from the account. Please visit Guides and Tutorials", "tags": [ - "/accounts" + "Disconnecting Numbers" ], "summary": "Disconnect numbers from account", "operationId": "CreateDisconnectOrder", @@ -3393,7 +3393,7 @@ "/accounts/{accountId}/disconnects/{disconnectid}": { "get": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Retrieves the information associated with the disconnect order specified.\nPlease visit Guides and Tutorials", "operationId": "ReadDisconnectOrder", @@ -3447,7 +3447,7 @@ "/accounts/{accountId}/disconnects/{disconnectid}/notes": { "get": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Retrieve all notes associated with the disconnect order. Please visit Guides and Tutorials", "operationId": "ReadDisconnectOrderNotes", @@ -3491,7 +3491,7 @@ }, "post": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Updates the Notes resource by adding a note. Adding a note to a disconnect \n 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 Tutorials", "operationId": "CreateDisconnectOrderNote", @@ -3552,7 +3552,7 @@ "/accounts/{accountId}/disconnects/{disconnectid}/notes/{noteId}": { "put": { "tags": [ - "/accounts" + "Disconnecting Numbers" ], "description": "Update a specified note. Notes may only be updated, not deleted. Please visit Guides and Tutorials\n", "operationId": "UpdateDisconnectOrderNote", @@ -4368,7 +4368,7 @@ "/accounts/{accountId}/emergencyNotificationRecipients": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "Retrieve a list of emergency notification recipients configured for this account.
\n Results can be paginated and filtered using the following query parameters.", "operationId": "ListEmergencyNotificationRecipients", @@ -4530,7 +4530,7 @@ }, "post": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "Create a new emergency notification recipient.", "summary": "Create emergency notification recipient", @@ -4655,7 +4655,7 @@ "/accounts/{accountId}/emergencyNotificationRecipients/{enrId}": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The GET operation is used to fetch the emergency notification recipient specified by its identifier.
\nURI parameters:

\n\n", "operationId": "RetrieveEmergencyNotificationRecipient", @@ -4747,7 +4747,7 @@ }, "put": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The PUT operation is used to replace an emergency notification recipient without changing its identifier value. All emergency notification recipient fields must be specified, even if they are not changing.", "operationId": "UpdateEmergencyNotificationRecipient", @@ -4883,7 +4883,7 @@ }, "delete": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The DELETE operation is used to remove the emergency notification recipient specified by its identifier.

\nAn emergency notification recipient cannot be removed if it is still used by an emergency notification group.\n If you wish to remove an emergency notification recipient that is associated with an emergency notificaiton group, use the /account/{accountId}/emergencyNotificationGroupOrders endpoint to remove the group or modify the group to no longer use this emergency notification recipient.\nURI parameters:\n ", "operationId": "DeleteEmergencyNotificationRecipient", @@ -4952,7 +4952,7 @@ "/accounts/{accountId}/emergencyNotificationGroupOrders": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The GET operation provides a means of fetching all of the emergency notification group order history for an account", "operationId": "ListEmergencyNotificationGroupOrders", @@ -5123,7 +5123,7 @@ }, "post": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The POST operation is used to create an order to create, update, or delete an emergency notification group.", "operationId": "CreateEmergencyNotificationGroupOrder", @@ -5256,7 +5256,7 @@ "/accounts/{accountId}/emergencyNotificationGroupOrders/{orderId}": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "This endpoint is used to query the status of a specified emergency notification group order, using the order-id that was assigned in the 201 response to the order creation.
\nWhen you query an order-id, look for the \"ProcessingStatus\" element in the 200 response. Values may be: PROCESSING, COMPLETED, or FAILED. PROCESSING means that the system is still processing the order. Please wait a couple of minutes and fetch the order results again. 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. Look for the \"ErrorList\" element to see what type of error occurred.
\nURI parameters:

\n\n", "operationId": "RetrieveEmergencyNotificationGroupOrder", @@ -5325,7 +5325,7 @@ "/accounts/{accountId}/emergencyNotificationGroups": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "Fetch emergency notification groups that are currently configured on the account. Use the provided query parameters to filter the results.
\nURI Parameters: accountId - the account id of the account to which the emergency notification group belongs

\n

Query parameters:
\nThe GET operation has no request payload, but the accountId must be specified in the URI parameter.\nResults are returned in the order of newest to oldest modification date of the Emergency Notification Group.\nQuery parameters act as filters on the data. If more than one query parameter is provided, the results will be the intersection of the results from each query parameter. In other words, the query parameters are logically ANDed.\nQuery parameters are appended to the end of the endpoint, separated by a '?' and in the format parameter=value. If you wish to specify more than one query parameter, separate them using an '&' character.\n The order of query parameters does not matter", "operationId": "ListEmergencyNotificationGroups", @@ -5461,7 +5461,7 @@ "/accounts/{accountId}/emergencyNotificationGroups/{engId}": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "This endpoint allows you to fetch the configuration of a current emergency notification group by identifier.", "operationId": "RetrieveEmergencyNotificationGroup", @@ -5564,7 +5564,7 @@ "/accounts/{accountId}/emergencyNotificationEndpointOrders": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The GET operation provides a means to query any Emergency Notification Endpoint Order associated with the account. This endpoint is for querying \"orders\", not the emergency endpoint to emergency notification group associations themselves. \n

The GET operation has no payload, although the accountId URI parameter is mandatory and a number of optional query parameters may be added. The query parameters are described in this section.\n Results are returned by default in the order of newest to oldest creation date of the Emergency Notification Endpoint Order. This default order is reversed from oldest to newest when the CreatedAfterDate query parameter is included in the query.\n Query parameters act as filters on the data. If more than one query parameter is provided, the results will be the intersection of the results from each query parameter. In other words, the query parameters are logically ANDed.\n Query parameters are appended to the end of the endpoint, separated by a '?' and in the format parameter=value. If you wish to specify more than one query parameter, separate them using an '&' character. The order of query parameters does not matter", "operationId": "ListEmergencyNotificationEndpointOrders", @@ -5735,7 +5735,7 @@ }, "post": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "The POST operation creates a new order to request that an emergency endpoint be added to or removed from an emergency notification group. A given order may either add or remove associations, not both in one order.
\n If the order is successfully created, a 201 response is returned, including an order-id that is used to query for completion of the order.
\n The order's ProcessingStatus is set to PROCESSING when the request is successfully created. When processing of all emergency endpoint to emergency notification group associations has been attempted, the software\n will update the order's processing status to either COMPLETED or FAILED.", "operationId": "CreateEmergencyNotificationEndpointOrder", @@ -5836,7 +5836,7 @@ "/accounts/{accountId}/emergencyNotificationEndpointOrders/{orderId}": { "get": { "tags": [ - "/accounts" + "Emergency Notification" ], "description": "This endpoint is used to fetch the status of an emergency notification endpoint order, using the order-id assigned when the order was created.
\nIf the order is still being processed, the ProcessingStatus will be PROCESSING. If the order has completed successfully, the ProcessingStatus will be COMPLETED. Otherwise the ProcessingStatus will be FAILED. If the ProcessingStatus is FAILED, look for the ErrorList in the payload to see reasons for the failure.\nURI parameters:

\n\n", "operationId": "RetrieveEmergencyNotificationEndpointOrder", @@ -5905,7 +5905,7 @@ "/accounts/{accountId}/externalTns": { "get": { "tags": [ - "/accounts" + "External Tn" ], "description": "

Retrieve a list of the externalTns orders that are associated with the account.

A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter (marked by * below) is provided, the order results will be limited to the last two years.

", "operationId": "ListExternalTnsOrder", @@ -6049,7 +6049,7 @@ }, "post": { "tags": [ - "/accounts" + "External Tn" ], "description": "

Create a externalTns order to add or remove telephone numbers provided by the customer from the Bandwidth network.

Note: the attempt to import a telephone number that is already present in the account will not create an error, but will reset all of the attributes of that telephone number in the Dashboard system as if the telephone number was being imported for the first time.

", "operationId": "CreateExternalTnsOrder", @@ -6110,7 +6110,7 @@ "/accounts/{accountId}/externalTns/{orderid}": { "get": { "tags": [ - "/accounts" + "External Tn" ], "description": "

Retrieve information about a externalTns order with specified ID.

", "operationId": "GetExternalTnsOrder", @@ -6166,7 +6166,7 @@ "/accounts/{accountId}/geocodeRequest": { "post": { "tags": [ - "/accounts" + "Addresses" ], "description": "POST is used to validate address as geocode-able one. Request payload is the address to geocode. If decomposed elements are provided for AddressLine 1 then AddressLine1 is ignored. At least HouseNumber and StreetName are required to use them as replacement of AddressLine1. If at least HouseNumber or StreetName is absent then AddressLine1 is used.", "operationId": "CreateGeocodeRequest", @@ -6324,7 +6324,7 @@ "/accounts/{accountId}/importTnChecker": { "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "

Request portability information on a set of TNs. SipPeerId is an optional value. If SipPeerId is not specified, the id of the default Sip-Peer for the provided SiteId will be used.

", "operationId": "CreateRequestImportTnChecker", @@ -6386,7 +6386,7 @@ "/accounts/{accountId}/importTnOrders": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the importtnorders requests for the given account ID. A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter (marked by * below) is provided, the order results will be limited to the last two years.\n", "summary": "List Import Tn orders", @@ -6504,7 +6504,7 @@ }, "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Creates an importTnOrders request to add numbers under the given site ID and sippeer ID as specified in the body.\nA successfully submitted order will have a status of \"RECEIVED\". A successfully completed order will have a status of \"COMPLETE\" if all of the telephone numbers were successfully imported and \"PARTIAL\" if some of the telephone numbers were imported. A failed order with will have a staus of \"FAILED\" and no telephone numbers would have been imported.", "summary": "Import Tn order", @@ -6565,7 +6565,7 @@ "/accounts/{accountId}/importTnOrders/{orderId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieve information about a importTnOrder with specified ID.", "summary": "Fetch Import Tn order status", @@ -6607,7 +6607,7 @@ "/accounts/{accountId}/importTnOrders/{orderId}/history": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the history of the specified importTnOrder.", "summary": "Fetch Import Tn order history", @@ -6649,7 +6649,7 @@ "/accounts/{accountId}/importTnOrders/{orderId}/loas": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the list of the loa (and other) files associated with the order.", "summary": "Fetch Import Tn order loas", @@ -6699,7 +6699,7 @@ }, "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "POSTing to the /loas resource will enable the upload of the file. The key attribute to the POST is ensuring that the headers are correctly set to support the file upload.
\nQuery parameter or header documentType can be used to specify type of document on upload.", "summary": "Import Tn order loas", @@ -6770,7 +6770,7 @@ "/accounts/{accountId}/importTnOrders/{orderId}/loas/{fileId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the file associated with the order.", "summary": "Fetch Import Tn order loas file", @@ -6811,7 +6811,7 @@ }, "put": { "tags": [ - "/accounts" + "Import Tn" ], "description": "A PUT on the filename will update / replace the identified file id. The format of the PUT is identical to that of the POST.", "summary": "Updating Import Tn order loas file", @@ -6867,7 +6867,7 @@ }, "delete": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Deletes the file associated with the order", "summary": "Removing Import Tn order loas file", @@ -6910,7 +6910,7 @@ "/accounts/{accountId}/importTnOrders/{orderId}/loas/{fileId}/metadata": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the metadata associated with the file.", "summary": "Fetch Import Tn order loas file metadata", @@ -6963,7 +6963,7 @@ }, "put": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Associate metadata with the file named in the resource path. This will describe the file, and declare the data that is contained in the file, selected from a list of [LOA | INVOICE | CSR | OTHER].", "summary": "Updating Import Tn order loas file metadata", @@ -7025,7 +7025,7 @@ }, "delete": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Deletes the metadata previously associated with the identified file.", "summary": "Removing Import Tn order loas file metadata", @@ -7068,7 +7068,7 @@ "/accounts/{accountId}/importTnOrders/voice": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the ImportVoiceTnOrder requests for the given account ID. A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter (marked by * below) is provided, the order results will be limited to the last two years.\n", "summary": "List Import Voice Tn orders", @@ -7171,7 +7171,7 @@ }, "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Creates an ImportVoiceTnOrders request to add numbers under the given site ID and sipPeer ID as specified in the body.\nA successfully submitted order will have a status of \"RECEIVED\". A successfully completed order will have a status of \"COMPLETE\" if all of the telephone numbers were successfully imported and \"PARTIAL\" if some of the telephone numbers were imported. A failed order with will have a staus of \"FAILED\" and no telephone numbers would have been imported.", "summary": "Import Voice Tn order", @@ -7232,7 +7232,7 @@ "/accounts/{accountId}/importTnOrders/voice/{orderId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieve information about a importVoiceTnOrder with specified ID.", "summary": "Fetch Import Voice Tn order status", @@ -7267,7 +7267,7 @@ "/accounts/{accountId}/importTnOrders/voice/{orderId}/history": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the history of the specified importVoiceTnOrder.", "summary": "Fetch Import Voice Tn order history", @@ -7302,7 +7302,7 @@ "/accounts/{accountId}/importToAccount": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieve a list of the Import to Account orders that have previously performed on the account. The query must always specify pagination parameters (size, page). The results can also be optionally limited with start date and end date .\n", "summary": "List Import to Account orders", @@ -7373,7 +7373,7 @@ }, "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Import a large number of previously ported or otherwise acquired numbers into the account\n", "summary": "Import to Account order", @@ -7434,7 +7434,7 @@ "/accounts/{accountId}/importToAccount/{orderId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieve information about a import to account order with specified ID.", "summary": "Fetch Import To Account order status", @@ -7476,7 +7476,7 @@ "/accounts/{accountId}/importToAccount/{orderId}/history": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the history of the specified importToAccount order.", "summary": "Fetch Import to Account order history", @@ -7518,7 +7518,7 @@ "/accounts/{accountId}/importToAccount/batches": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "The batches resource enumerates all of the batches that have been used for importing numbers into an account.\n If there is the need to import a large number of Telephone Numbers into an account, the import is submitted as a batch, which is a collection of submissions that are held together by a batch id. This batch of orders can subsequently be retrieved by retrieving all of the orders that share a batch id.", "summary": "List Import to Account orders batches", @@ -7551,7 +7551,7 @@ "/accounts/{accountId}/importToAccount/batches/{batchId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "A batchid identifies a specific batch of one or more orders that constitute a complete import of a (potentially large number of) Telephone Numbers. Retrieving the information associated with a specific batch id describes the orders that were included in that batch, and the status and id of those orders.", "summary": "Fetch Import To Account orders status by batch id", @@ -12206,7 +12206,7 @@ "/accounts/{accountId}/realms": { "get": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Retrieve all Realms for the account", "operationId": "RetrieveRealms", @@ -12271,7 +12271,7 @@ }, "post": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Create a Realm", "operationId": "CreateRealm", @@ -12341,7 +12341,7 @@ "/accounts/{accountId}/realms/{realm}": { "get": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Retrieve a Realm associated with the account", "operationId": "RetrieveRealm", @@ -12405,7 +12405,7 @@ }, "put": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Update a Realm", "operationId": "UpdateRealm", @@ -12483,7 +12483,7 @@ }, "delete": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Delete a Realm", "operationId": "DeleteRealm", @@ -12549,7 +12549,7 @@ "/accounts/{accountId}/realms/{realmId}/sipcredentials": { "get": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Retrieve all SIP credentials for the account ID and realm ID specified", "operationId": "ListSipCredentialsOnRealm", @@ -12659,7 +12659,7 @@ }, "post": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Create SIP credentials on the Realm", "operationId": "CreateSipCredentialsOnRealm", @@ -12739,7 +12739,7 @@ "/accounts/{accountId}/realms/{realmId}/sipcredentials/{credentialId}": { "get": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Retrieve a SIP credential for the account and realm specified by its assigned ID", "operationId": "RetrieveSipCredentialOnRealm", @@ -12801,7 +12801,7 @@ }, "put": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Update single SIP credential on the Realm", "operationId": "UpdateSipCredentialOnRealm", @@ -12901,7 +12901,7 @@ }, "delete": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Delete SIP credential on the Realm", "operationId": "DeleteSipCredentialOnRealm", @@ -12965,7 +12965,7 @@ "/accounts/{accountId}/removeImportedTnOrders": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the Remove Imported Tn Orders requests for the given account ID.\nA maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter as required is provided, the order results will be limited to the last two years.", "summary": "List Remove Imported Tn Orders", @@ -13074,7 +13074,7 @@ }, "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Creates a Remove Imported Tn Orders request to remove imported telephone numbers from the given site ID and sippeer ID as specified in the body. A successfully submitted order will have a status of \"PROCESSING\". A successfully completed order will have a status of \"COMPLETE\" if all of the telephone numbers were successfully removed and \"PARTIAL\" if some of the telephone numbers were removed. A failed order with will have a status of \"FAILED\" and no telephone numbers would have been removed", "summary": "Create Remove Imported Tn Order", @@ -13132,7 +13132,7 @@ "/accounts/{accountId}/removeImportedTnOrders/{orderId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieve information about a removeImportedTnOrder with specified ID", "summary": "Retrieve Remove Imported Tn Order", @@ -13174,7 +13174,7 @@ "/accounts/{accountId}/removeImportedTnOrders/{orderId}/history": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the history of the specified Remove Imported Tn Order", "summary": "Retrieve Remove Imported Tn Order history", @@ -13216,7 +13216,7 @@ "/accounts/{accountId}/removeImportedTnOrders/voice": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the Remove Imported Voice Tn Orders requests for the given account ID.\nA maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter as required is provided, the order results will be limited to the last two years.", "summary": "List Remove Imported Voice Tn Orders", @@ -13309,7 +13309,7 @@ }, "post": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Creates a Remove Imported Voice Tn Orders request to remove imported telephone numbers from the given site ID and sippeer ID as specified in the body. A successfully submitted order will have a status of \"PROCESSING\". A successfully completed order will have a status of \"COMPLETE\" if all of the telephone numbers were successfully removed and \"PARTIAL\" if some of the telephone numbers were removed. A failed order with will have a status of \"FAILED\" and no telephone numbers would have been removed", "summary": "Create Remove Imported Voice Tn Order", @@ -13367,7 +13367,7 @@ "/accounts/{accountId}/removeImportedTnOrders/voice/{orderId}": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieve information about a removeImportedVoiceTnOrder with specified ID", "summary": "Retrieve Remove Imported Voice Tn Order", @@ -13402,7 +13402,7 @@ "/accounts/{accountId}/removeImportedTnOrders/voice/{orderId}/history": { "get": { "tags": [ - "/accounts" + "Import Tn" ], "description": "Retrieves the history of the specified Remove Imported Voice Tn Order", "summary": "Retrieve Remove Imported Voice Tn Order history", @@ -13856,7 +13856,7 @@ "/accounts/{accountId}/sipcredentials": { "get": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Retrieve all SIP credentials for the account", "summary": "Retrieve SIP Credentials", @@ -13968,7 +13968,7 @@ }, "post": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Create SIP credentials and associate them with the account", "summary": "Create SIP Credentials", @@ -14038,7 +14038,7 @@ "/accounts/{accountId}/sipcredentials/{compositeUserName}": { "get": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Retrieve a SIP credential for the account by unique combination of user name and domain", "summary": "Retrieve SIP Credential", @@ -14093,7 +14093,7 @@ }, "put": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Update single SIP credential\nIt is not possible to change the UserName or the Domain associated with the Hash Values. To do so requires deletion of one set of credentials and addition of a new set of credentials", "summary": "Update SIP Credentials", @@ -14186,7 +14186,7 @@ }, "delete": { "tags": [ - "/accounts" + "Sip Registrar" ], "description": "Delete SIP credential", "summary": "Delete SIP Credentials", @@ -16953,7 +16953,7 @@ "/accounts/{accountId}/subscriptions": { "get": { "tags": [ - "/accounts" + "Subscriptions" ], "description": "GET is used to retrieve all subscriptions for the account (including email and callback subscriptions). The returned information reflects the subscription as it has been defined, and for callback subscriptions will reflect the status of the latest attempt to place the callback. The `Status` element will indicate if an error is being encountered when the Bandwidth Dashboard API attempts to place the callback.", "operationId": "GetSubscriptions", @@ -16993,7 +16993,7 @@ }, "post": { "tags": [ - "/accounts" + "Subscriptions" ], "description": "

A POST on the /subscriptions resource is used to request a new subscriptions for an account. The POST creates a new e-mail or callback subscription. A well-formed POST will create a subscription resource, and return a subscription ID as part of the location header. The ID is used to uniquely identify the subscription. The user should submit the desired e-mail address for notifications and the frequency with which he wants to get the updates: DAILY (for daily digests) or NONE (immediately after events). OrderId is optional. If OrderId is specified only notifications will be sent for events related to that order. If OrderId is omitted, notifications will be sent related to events of all orders of the specified type.

The credentials used to impose security on the callbacks are defined in the element. The Basic authentication is straightforward, but the requires a little more explanation. Please see the document to the left on Mutual Authentication for CallBacks. can be omitted if the url is http, but using https is recommended for security.

When status changes on an order that had been subscribed to with a callback subscription (order update, note added to order), the following payload will be POSTed to the URL of the callback subscription. More detail can be found in the API documentation for the fictitious endpoint /callbacks

When a event happens that had been subscribed to with a callback subscription (messaging lost, messaging gained etc.), the following payload will be POSTed to the URL of the callback subscription. More detail can be found in the API documentation for the fictitious endpoint /callbacks", "operationId": "CreateSubscriptions", @@ -17198,7 +17198,7 @@ "/accounts/{accountId}/subscriptions/{subscriptionid}": { "get": { "tags": [ - "/accounts" + "Subscriptions" ], "description": "

Retrieves the information associated with the subscription ID.\nThe returned information reflects the subscription as it has been defined, and for callback subscriptions will reflect the status of the latest attempt to place the callback. The element will indicate if an error is being encountered when the Bandwidth Dashboard API attempts to place the callback.\n<Expiry> in the GET response payload, shows how many seconds are remaining before expiration of the subscription.

\n", "operationId": "GetSubscription", @@ -17250,7 +17250,7 @@ }, "put": { "tags": [ - "/accounts" + "Subscriptions" ], "description": "Updates the subscription. This can be used to update various values (expiry, email address, url, credentials...). Note that the initial state changes for an order may happen very quickly, so subscribing to an order once the system creates it needs to account for the fact that the initial state may be different based on timing factors. It is recommended that the application creating the subscription check the order status after the subscription is created to ensure the correct initial condition. The same rules around valid or possible values as for POSTs apply.", "operationId": "UpdateSubscription", @@ -17318,7 +17318,7 @@ }, "delete": { "tags": [ - "/accounts" + "Subscriptions" ], "description": "Deletes the specified subscription. Note that deleting subscriptions is only supported on a one-by-one basis. Deleting all subscriptions associated with an order requires GETting all of those subscriptions, then deleting them one by one.", "operationId": "DeleteSubscription", @@ -17364,7 +17364,7 @@ "/accounts/{accountId}/tnoptions": { "get": { "tags": [ - "/accounts" + "Tn Option" ], "description": "Retrieve a list of the TN Option orders that are associated with the account. A maximum of 1,000 orders can be retrieved per request. If no date range or specific query parameter (marked by * below) is provided, the order results will be limited to the last two years.", "operationId": "GetTnOptionOrders", @@ -17519,7 +17519,7 @@ }, "post": { "tags": [ - "/accounts" + "Tn Option" ], "description": "Create TN Option order to assign line features to the telephone number.

Attribute description:", "operationId": "CreateTnOptionOrder", @@ -17595,7 +17595,7 @@ "/accounts/{accountId}/tnoptions/{orderid}": { "get": { "tags": [ - "/accounts" + "Tn Option" ], "description": "Retrieve information about a TN Option Order with specified ID.", "operationId": "GetTnOptionOrder", @@ -17651,7 +17651,7 @@ "/accounts/{accountId}/tnoptions/{orderid}/history": { "get": { "tags": [ - "/accounts" + "Tn Option" ], "description": "Retrieve the history information associated with an order.", "operationId": "GetOrderHistory", @@ -33648,6 +33648,28 @@ "url": "/docs/emergency/dashboard/dlr/" } }, + { + "name": "Disconnecting Numbers", + "description": "Disconnecting a phone number leaves it in all applicable inventories, but makes it available for activation with a new subscriber.", + "externalDocs": { + "description": "Disconnecting number guide", + "url": "/docs/numbers/guides/disconnectNumbers/" + } + }, + { + "name": "Emergency Notification", + "description": "Emergency notifications are designed to support notification of front-desk personnel in the event that someone dials an emergency call from a multi-line telephone system (MLTS).", + "externalDocs": { + "description": "Emergency notification guide", + "url": "/docs/emergency/dashboard/notifications/" + } + }, + { + "name": "External Tn" + }, + { + "name": "Import Tn" + }, { "name": "LIDB", "description": "LIDB - Line Information DataBase", @@ -33674,6 +33696,26 @@ "url": "/docs/numbers/guides/downloadingReports/" } }, + { + "name": "Sip Registrar", + "externalDocs": { + "description": "Sip Registrar guide", + "url": "/docs/account/sipRegistrar/#create-sip-credentials" + } + }, + { + "name": "SipPeer products" + }, + { + "name": "Subscriptions", + "externalDocs": { + "description": "Subscriptions details", + "url": "/docs/account/subscriptions/" + } + }, + { + "name": "Tn Option" + }, { "name": "Tns" },