From ae592bae3af143d5b219658fe1ac1fdecc75e260 Mon Sep 17 00:00:00 2001 From: erikkai Date: Tue, 19 Jul 2016 11:01:43 -0700 Subject: [PATCH] Update README.rst --- README.rst | 120 ++++++++++++++++++++++++++++++----------------------- 1 file changed, 68 insertions(+), 52 deletions(-) diff --git a/README.rst b/README.rst index 4e2f65f..e6c570e 100644 --- a/README.rst +++ b/README.rst @@ -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 ------------