Skip to content

Update README.rst w Telebureau class info #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hmorales merged 1 commit into from
Jul 19, 2016
Merged

Update README.rst w Telebureau class info #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 68 additions & 52 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,58 +16,74 @@ The **TeleSign Python SDK** is a set of software development tools— a *Python
The Python Classes
------------------

With just two classes, **telesign.api** abstracts much of the complexity of the TeleSign REST API.

+----------------------+--------------------------------------------------------------------------+
| Python Class | Description |
+======================+==========================================================================+
| telesign.api.PhoneId | The **PhoneId** class exposes four services that each provide |
| | information about a specified phone number. |
| | |
| | *standard* |
| | Retrieves the standard set of details about the specified phone |
| | number. This includes the type of phone (for example, land line |
| | or mobile), and its approximate geographic location. |
| | *score* |
| | Retrieves a score for the specified phone number. This ranks the |
| | phone number's "risk level" on a scale from 0 to 1000, so you can |
| | code your web application to handle particular use cases (for |
| | example, to stop things like chargebacks, identity theft, fraud, |
| | and spam). |
| | *contact* |
| | In addition to the information retrieved by *standard*, this service |
| | provides the name and address associated with the specified phone |
| | number. |
| | *live* |
| | In addition to the information retrieved by *standard*, this service |
| | provides actionable data associated with the specified phone number. |
| | |
| | |
+----------------------+--------------------------------------------------------------------------+
| telesign.api.Verify | The **Verify** class exposes three services for sending users a |
| | verification token (a three to five-digit number). You can use this |
| | mechanism to test whether you can reach users at the phone number |
| | they supplied, or you can have them use the token to authenticate |
| | themselves with your web application. In addition, this class also |
| | exposes a service that allows you to confirm the result of the |
| | authentication. |
| | |
| | You can use this verification factor in combination with *username* |
| | and *password* to provide *two-factor* authentication for higher |
| | security. |
| | |
| | *call* |
| | Calls the specified phone number and uses speech synthesis to speak |
| | the verification code to the user. |
| | *sms* |
| | Sends a text message containing the verification code to the |
| | specified phone number (supported for mobile phones only). |
| | *status* |
| | Retrieves the verification result. You make this call in your web |
| | application after users complete the authentication transaction |
| | (using either a *call* or *sms*). |
| | |
+----------------------+--------------------------------------------------------------------------+
With just three classes, **telesign.api** abstracts much of the complexity of the TeleSign REST API.

+-------------------------+--------------------------------------------------------------------------+
| Python Class | Description |
+=========================+==========================================================================+
| telesign.api.PhoneId | The **PhoneId** class exposes four services that each provide |
| | information about a specified phone number. |
| | |
| | *standard* |
| | Retrieves the standard set of details about the specified phone |
| | number. This includes the type of phone (for example, land line |
| | or mobile), and its approximate geographic location. |
| | *score* |
| | Retrieves a score for the specified phone number. This ranks the |
| | phone number's "risk level" on a scale from 0 to 1000, so you can |
| | code your web application to handle particular use cases (for |
| | example, to stop things like chargebacks, identity theft, fraud, |
| | and spam). |
| | *contact* |
| | In addition to the information retrieved by *standard*, this service |
| | provides the name and address associated with the specified phone |
| | number. |
| | *live* |
| | In addition to the information retrieved by *standard*, this service |
| | provides actionable data associated with the specified phone number. |
| | |
| | |
+-------------------------+--------------------------------------------------------------------------+
| telesign.api.Verify | The **Verify** class exposes three services for sending users a |
| | verification token (a three to five-digit number). You can use this |
| | mechanism to test whether you can reach users at the phone number |
| | they supplied, or you can have them use the token to authenticate |
| | themselves with your web application. In addition, this class also |
| | exposes a service that allows you to confirm the result of the |
| | authentication. |
| | |
| | You can use this verification factor in combination with *username* |
| | and *password* to provide *two-factor* authentication for higher |
| | security. |
| | |
| | *call* |
| | Calls the specified phone number and uses speech synthesis to speak |
| | the verification code to the user. |
| | *sms* |
| | Sends a text message containing the verification code to the |
| | specified phone number (supported for mobile phones only). |
| | *status* |
| | Retrieves the verification result. You make this call in your web |
| | application after users complete the authentication transaction |
| | (using either a *call* or *sms*). |
| | |
+-------------------------+--------------------------------------------------------------------------+
| telesign.api.Telebureau | The **Telebureau** class exposes services for creating, retrieving, |
| | updating and deleting telebureau fraud events. You can use this |
| | mechanism to test whether you can reach Telebureau services. |
| | |
| | *create* |
| | Creates a Telebureau event corresponding to supplied data. |
| | *retrieve* |
| | Retrieves the fraud event status. You make this call in your web |
| | application after completion of create/update transaction for a |
| | Telebureau event. |
| | *delete* |
| | Deletes a previously submitted fraud event. You make this call in |
| | your web application after completion of submit/update transaction |
| | for a Telebureau event. |
| | |
+-------------------------+--------------------------------------------------------------------------+

Installation
------------
Expand Down