From bd3f9be48bbb8236a84a4a1b83b9906358f6c416 Mon Sep 17 00:00:00 2001 From: Maria Bermudez Date: Fri, 1 Jun 2018 12:50:16 -0700 Subject: [PATCH 1/3] Update CNAM anchor links --- README.md | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 0a6544e..f1c349b 100644 --- a/README.md +++ b/README.md @@ -40,7 +40,7 @@ The Flowroute Python Library v3 provides methods for interacting with [Numbers v * [get_e911](#get_e911e911_id) * [validate_address](#validate_addresse911_attributes) * [create_address](#create_addresse911_attributes) - * [update_address](#e911_ide911_attribute) + * [update_address](#update_addresse911_id-e911_attributes) * [associate](#associatee911_id-number_id) * [list_dids_for_e911](#list_dids_for_e911e911_id) * [disconnect](#disconnectnumber_id) @@ -50,7 +50,7 @@ The Flowroute Python Library v3 provides methods for interacting with [Numbers v * [list_cnams](#list_cnams) * [get_cnam](#get_cnamcnam_id) * [create_cnam_record](#create_cnam_recordcnam_value) - * [associate_cnam](#associatecnam_id-number_id) + * [associate_cnam](#associate_cnamcnam_id-number_id) * [unassociate_cnam](#unassociate_cnamnumber_id) * [remove_cnam](#remove_cnamcnam_id) @@ -133,7 +133,7 @@ Contains all of the methods necessary to create, update, and validate new and ex * [create\_address(e911\_attributes)](#create_addresse911_attributes) \- Lets you create and validate an E911 address within the US and Canada which can then be assigned to any of the long code or toll­free numbers on your account. To assign an E911 address to your number, see the [associate](#associatee911_id-number_id) method. * [update\_address(e911\_id, e911\_attributes)](#update_addresse911_id-e911_attributes) \- Lets you update and validate an existing E911 address on your account. You must create the E911 address first by following the [create\_address](#create_address) method. * [associate(e911\_id, number\_id)](#associatee911_id-number_id) \- Lets you assign a valid E911 address to a specific long code or toll-free phone number in your account. This method calls an endpoint which does not return an error for subsequent attempts at associating a phone number with the same E911 record. The E911 record assignment charge only occurs on the first successful attempt. Note that you can later assign a different `e911_id` to the same phone number and will be charged accordingly. -* [list\_dids\_for\_e911(e911\_id)](#list_dids_for_e911number_id) \- Returns a list of your Flowroute long code or toll-free phone numbers associated with a specified E911 record. +* [list\_dids\_for\_e911(e911\_id)](#list_dids_for_e911e911_id) \- Returns a list of your Flowroute long code or toll-free phone numbers associated with a specified E911 record. * [disconnect(number\_id)](#disconnectnumber_id) \- Lets you deactivate the current E911 service for your phone number. * [delete\_address(e911\_id)](#delete_addresse911_id) \- Lets you delete an E911 address associated with your account. You must remove all phone number associations first before you can successfully delete the specified E911 record. @@ -141,11 +141,11 @@ Contains all of the methods necessary to create, update, and validate new and ex Contains all of the methods necessary to create and delete CNAM records, view all of the CNAM records associated with your account, filter for specific CNAM records by status, review CNAM record details, and assign and unassign CNAM records to your Flowroute long code phone numbers. * [list\_cnams()](#list_cnams) \- Returns a list of all CNAM records on your account by default. You can apply search filters using any of the available query parameters. -* [get\_cnam(cnam\_id)](#get_cnam) \- Returns details pertaining to a specific CNAM record on your account, including long code numbers that are associated with the record. -* [create\_cnam\_record(cnam\_value)](#create_cnam_record) \- Lets you create a Caller ID record for your account which can then be assigned to any of your long code numbers. To assign a CNAM record to your number, see the [associate\_cnam](#associate_cnam) method. -* [associate\_cnam(cnam\_id, number\_id)](#associate) \- Lets you associate a CNAM record with a specified long code number on your account. Note that a CNAM record takes 1-2 days to be approved. -* [unassociate(number\_id)](#disconnect) \- Lets you unassign a CNAM record associated with a specified long code number on your account without deleting the CNAM record itself. -* [remove\_cnam(cnam\_id)](#remove_cnam) \- Lets you delete a CNAM record from your account. Note that this will automatically disassociate all numbers associated with the deleted CNAM record. +* [get\_cnam(cnam\_id)](#get_cnamcnam_id) \- Returns details pertaining to a specific CNAM record on your account, including long code numbers that are associated with the record. +* [create\_cnam\_record(cnam\_value)](#create_cnam_recordcnam_value) \- Lets you create a Caller ID record for your account which can then be assigned to any of your long code numbers. To assign a CNAM record to your number, see the [associate\_cnam](#associate_cnamcnam_id-number_id) method. +* [associate\_cnam(cnam\_id, number\_id)](#associate_cnamcnam_id-number_id) \- Lets you associate a CNAM record with a specified long code number on your account. Note that a CNAM record takes 1-2 days to be approved. +* [unassociate(number\_id)](#unassociate_cnamnumber_id) \- Lets you unassign a CNAM record associated with a specified long code number on your account without deleting the CNAM record itself. +* [remove\_cnam(cnam\_id)](#remove_cnamcnam_id) \- Lets you delete a CNAM record from your account. Note that this will automatically disassociate all numbers associated with the deleted CNAM record. The following shows an example of a single Python file that imports the Flowroute API client and all the required modules. The Python Library v3 comes with three example demo files — **number_route_message_demo.py**, **e911_demo.py**, **cnam_demo.py** — files that you can edit and run for demonstration and testing purposes. @@ -1165,7 +1165,6 @@ On success, the HTTP status code in the response header is `200 OK` and the resp } } ``` -disconnect(number\_id)](#disconnectnumber_id) #### disconnect(number_id) From 885e6be2cc78f46430110e9e7e0d78fa7fe2672a Mon Sep 17 00:00:00 2001 From: Maria Bermudez Date: Thu, 12 Jul 2018 17:04:39 -0700 Subject: [PATCH 2/3] Documentation bug fixes --- README.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f1c349b..56e0ffc 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Flowroute Python Library v3 ===================== -The Flowroute Python Library v3 provides methods for interacting with [Numbers v2](https://developer.flowroute.com/api/numbers/v2.0/) and [Messages v2.1](https://developer.flowroute.com/api/messages/v2.1/) of the [Flowroute](https://www.flowroute.com) API. +The Flowroute Python Library v3 provides methods for interacting with [Numbers v2](https://developer.flowroute.com/api/numbers/v2.0/) &endash; which includes inbound voice routes, E911 addresses, and CNAM storage &endash; and [Messages v2.1](https://developer.flowroute.com/api/messages/v2.1/) of the [Flowroute](https://www.flowroute.com) API. **Topics** @@ -91,7 +91,7 @@ Depending on your `pip` permissions, you may be required to preface each `pip` c * * * Usage ------------ -In Flowroute's approach to building the Python Library v3, HTTP requests are handled by controllers named after the API resources they represent: **Numbers**, **Routes**, **E911s**, **CNAMs**, and **Messages**. These controllers contain the methods used to perform messaging, number management, route management, E911 address management, and CNAM record management within the Python library. +In Flowroute's approach to building the Python Library v3, HTTP requests are handled by controllers named after the API resources they represent: **Numbers**, **Routes**, **E911s**, **CNAMs**, and **Messages**. These controllers contain the methods used to perform messaging, number management, route management, E911 address management, and CNAM record management within the Python library. ## Controllers @@ -993,7 +993,7 @@ On success, the HTTP status code in the response header is `200 OK` and the resp #### validate_address(e911_attributes) -The method accepts the different attributes of an E911 address as parameters: `label`, `first_name`, `last_name`, `street_name`, `street_number`, `city`, `state`, `country`, and `zipcode`. Learn more about the different E911 attributes in the [API reference](https://developer.flowroute.com/api/e911s/v2.0/validate-e911-address/). Note that this method doesn't accept the `address_type` and `address_type_number` which are acceptable but not required E911 address attributes by the API. +The method accepts the different attributes of an E911 address as parameters: `label`, `first_name`, `last_name`, `street_name`, `street_number`, optional `address_type` and `address_type_number`, `city`, `state`, `country`, and `zipcode`. Learn more about the different E911 attributes in the [API reference](https://developer.flowroute.com/api/e911s/v2.0/validate-e911-address/). ##### Example Request ``` @@ -1025,7 +1025,7 @@ HTTP response not OK. ``` #### create_address(e911_attributes) -The method accepts the different attributes of an E911 address as parameters: `label`, `first_name`, `last_name`, `street_name`, `street_number`, `city`, `state`, `country`, and `zipcode`. Learn more about the different E911 attributes in the [API reference](https://developer.flowroute.com/api/e911s/v2.0/create-and-validate-new-e911-address/). Note that this method doesn't accept the `address_type` and `address_type\_number` which are acceptable but not required E911 address attributes by the API. +The method accepts the different attributes of an E911 address as parameters: `label`, `first_name`, `last_name`, `street_name`, `street_number`, optional `address_type` and `address_type_number`, `city`, `state`, `country`, and `zipcode`. Learn more about the different E911 attributes in the [API reference](https://developer.flowroute.com/api/e911s/v2.0/create-and-validate-new-e911-address/). ##### Example Request ``` @@ -1068,7 +1068,7 @@ On success, the HTTP status code in the response header is `201 Created` and the ``` #### update_address(e911_id, e911_attributes) -The method accepts an E911 record id and the different attributes of an E911 address as parameters: `label`, `first_name`, `last_name`, `street_name`, `street_number`, `city`, `state`, `country`, and `zipcode`. Learn more about the different E911 attributes that you can update in the [API reference](https://developer.flowroute.com/api/e911s/v2.0/update-and-validate-existing-e911-address/). Note that this method doesn't accept the `address_type` and `address_type_number` which are acceptable but not required E911 address attributes by the API. In the following example, we will retrieve the record ID of our newly created E911 address and assign it to a variable, `record_id`. We then update the `last_name` of our selected E911 address to "Wiley". +The method accepts an E911 record id and the different attributes of an E911 address as parameters: `label`, `first_name`, `last_name`, `street_name`, `street_number`, `city`, `state`, `country`, and `zipcode`. Learn more about the different E911 attributes that you can update in the [API reference](https://developer.flowroute.com/api/e911s/v2.0/update-and-validate-existing-e911-address/). In the following example, we will retrieve the record ID of our newly created E911 address and assign it to a variable, `record_id`. We then update the `last_name` of our selected E911 address to "Wiley". ##### Example Request ``` @@ -1130,7 +1130,10 @@ except Exception as e: On success, the HTTP status code in the response header is `204 No Content` which means that the server successfully processed the request and is not returning any content. -`204: No Content` +``` +--Associate an E911 Record and a DID +204: No Content +``` #### list_dids_for_e911(e911_id) From 66267cb2f71ed10629fc54c0fbf226152d979dae Mon Sep 17 00:00:00 2001 From: Maria Bermudez Date: Fri, 13 Jul 2018 11:23:56 -0700 Subject: [PATCH 3/3] Fix documentation bugs --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 56e0ffc..41b4945 100644 --- a/README.md +++ b/README.md @@ -1350,7 +1350,7 @@ print("\nNOTE: Newly created CNAM records need to be approved first before they ##### Example Response -On success, the HTTP status code in the response header is `201 Created` and the response body contains the newly created cnam object in JSON format. +On success, the HTTP status code in the response header is `201 Created` and the response body contains the newly created cnam object in JSON format. Note that CNAM records take up to 48 hours to be approved on your account and further association with a phone number takes 5-7 business days. ``` --Create a CNAM Record