From cad6bbb44f98d8509cdbbd4aa9bca43d68c2887e Mon Sep 17 00:00:00 2001 From: Chris Boorman Date: Mon, 11 Mar 2013 19:31:23 -0700 Subject: [PATCH 1/2] Added Javadoc comments for all API members. Added the file Overview.html, that describes the SDK as a whole. Added five files called package.html, that describe each package. Configured the Eclipse project to include links to the Javadocs for the referenced libraries (the official JDK docs, commons-codec, and gson). All of these types are now hot-linked on our docs. Created an Ant build.xml script for building the HTML docs. This script includes JavaScript for automatically generating information in the header, footer, and bottom of each web page (date stamp, product name and version, copyright information. --- .classpath | 16 + .project | 17 + ant.properties | 7 + bin/com/telesign/phoneid/package.html | 21 + .../telesign/phoneid/response/package.html | 8 + bin/com/telesign/util/package.html | 8 + bin/com/telesign/verify/package.html | 13 + bin/com/telesign/verify/response/package.html | 8 + build.xml | 33 + doc/allclasses-frame.html | 4 +- doc/allclasses-noframe.html | 4 +- doc/com/telesign/PhoneIdTest.html | 390 +++++++++ doc/com/telesign/TeleSignRequestTest.html | 286 +++++++ doc/com/telesign/VerifyTest.html | 377 +++++++++ doc/com/telesign/class-use/PhoneIdTest.html | 115 +++ .../class-use/TeleSignRequestTest.html | 115 +++ doc/com/telesign/class-use/VerifyTest.html | 115 +++ doc/com/telesign/package-frame.html | 21 + doc/com/telesign/package-summary.html | 147 ++++ doc/com/telesign/package-tree.html | 130 +++ doc/com/telesign/package-use.html | 115 +++ doc/com/telesign/phoneid/PhoneId.html | 215 ++--- .../telesign/phoneid/class-use/PhoneId.html | 9 +- doc/com/telesign/phoneid/package-frame.html | 4 +- doc/com/telesign/phoneid/package-summary.html | 36 +- doc/com/telesign/phoneid/package-tree.html | 11 +- doc/com/telesign/phoneid/package-use.html | 9 +- .../PhoneIdContactResponse.Contact.html | 150 ++-- .../PhoneIdContactResponse.Error.html | 38 +- ...dContactResponse.Location.Coordinates.html | 34 +- ...oneIdContactResponse.Location.Country.html | 51 +- ...neIdContactResponse.Location.TimeZone.html | 63 +- .../PhoneIdContactResponse.Location.html | 135 ++-- ...onse.Numbering.CleansingNumber.Number.html | 79 +- ...actResponse.Numbering.CleansingNumber.html | 50 +- ...tactResponse.Numbering.OriginalNumber.html | 63 +- .../PhoneIdContactResponse.Numbering.html | 54 +- .../PhoneIdContactResponse.PhoneType.html | 38 +- .../PhoneIdContactResponse.Status.html | 61 +- .../response/PhoneIdContactResponse.html | 177 ++-- .../response/PhoneIdLiveResponse.Error.html | 38 +- .../response/PhoneIdLiveResponse.Live.html | 77 +- ...neIdLiveResponse.Location.Coordinates.html | 34 +- .../PhoneIdLiveResponse.Location.Country.html | 51 +- ...PhoneIdLiveResponse.Location.TimeZone.html | 63 +- .../PhoneIdLiveResponse.Location.html | 135 ++-- ...onse.Numbering.CleansingNumber.Number.html | 79 +- ...iveResponse.Numbering.CleansingNumber.html | 50 +- ...LiveResponse.Numbering.OriginalNumber.html | 63 +- .../PhoneIdLiveResponse.Numbering.html | 54 +- .../PhoneIdLiveResponse.PhoneType.html | 38 +- .../response/PhoneIdLiveResponse.Status.html | 61 +- .../phoneid/response/PhoneIdLiveResponse.html | 178 ++-- .../response/PhoneIdScoreResponse.Error.html | 38 +- ...onse.Numbering.CleansingNumber.Number.html | 79 +- ...oreResponse.Numbering.CleansingNumber.html | 50 +- ...coreResponse.Numbering.OriginalNumber.html | 63 +- .../PhoneIdScoreResponse.Numbering.html | 54 +- .../PhoneIdScoreResponse.PhoneType.html | 38 +- .../response/PhoneIdScoreResponse.Risk.html | 57 +- .../response/PhoneIdScoreResponse.Status.html | 61 +- .../response/PhoneIdScoreResponse.html | 157 ++-- .../PhoneIdStandardResponse.Error.html | 38 +- ...StandardResponse.Location.Coordinates.html | 34 +- ...neIdStandardResponse.Location.Country.html | 51 +- ...eIdStandardResponse.Location.TimeZone.html | 63 +- .../PhoneIdStandardResponse.Location.html | 135 ++-- ...onse.Numbering.CleansingNumber.Number.html | 79 +- ...ardResponse.Numbering.CleansingNumber.html | 50 +- ...dardResponse.Numbering.OriginalNumber.html | 63 +- .../PhoneIdStandardResponse.Numbering.html | 54 +- .../PhoneIdStandardResponse.PhoneType.html | 38 +- .../PhoneIdStandardResponse.Status.html | 61 +- .../response/PhoneIdStandardResponse.html | 168 ++-- .../PhoneIdContactResponse.Contact.html | 18 +- .../PhoneIdContactResponse.Error.html | 18 +- ...dContactResponse.Location.Coordinates.html | 18 +- ...oneIdContactResponse.Location.Country.html | 18 +- ...neIdContactResponse.Location.TimeZone.html | 18 +- .../PhoneIdContactResponse.Location.html | 18 +- ...onse.Numbering.CleansingNumber.Number.html | 22 +- ...actResponse.Numbering.CleansingNumber.html | 18 +- ...tactResponse.Numbering.OriginalNumber.html | 18 +- .../PhoneIdContactResponse.Numbering.html | 18 +- .../PhoneIdContactResponse.PhoneType.html | 18 +- .../PhoneIdContactResponse.Status.html | 18 +- .../class-use/PhoneIdContactResponse.html | 20 +- .../class-use/PhoneIdLiveResponse.Error.html | 18 +- .../class-use/PhoneIdLiveResponse.Live.html | 18 +- ...neIdLiveResponse.Location.Coordinates.html | 18 +- .../PhoneIdLiveResponse.Location.Country.html | 18 +- ...PhoneIdLiveResponse.Location.TimeZone.html | 18 +- .../PhoneIdLiveResponse.Location.html | 18 +- ...onse.Numbering.CleansingNumber.Number.html | 22 +- ...iveResponse.Numbering.CleansingNumber.html | 18 +- ...LiveResponse.Numbering.OriginalNumber.html | 18 +- .../PhoneIdLiveResponse.Numbering.html | 18 +- .../PhoneIdLiveResponse.PhoneType.html | 18 +- .../class-use/PhoneIdLiveResponse.Status.html | 18 +- .../class-use/PhoneIdLiveResponse.html | 20 +- .../class-use/PhoneIdScoreResponse.Error.html | 18 +- ...onse.Numbering.CleansingNumber.Number.html | 22 +- ...oreResponse.Numbering.CleansingNumber.html | 18 +- ...coreResponse.Numbering.OriginalNumber.html | 18 +- .../PhoneIdScoreResponse.Numbering.html | 18 +- .../PhoneIdScoreResponse.PhoneType.html | 9 +- .../class-use/PhoneIdScoreResponse.Risk.html | 18 +- .../PhoneIdScoreResponse.Status.html | 18 +- .../class-use/PhoneIdScoreResponse.html | 20 +- .../PhoneIdStandardResponse.Error.html | 18 +- ...StandardResponse.Location.Coordinates.html | 18 +- ...neIdStandardResponse.Location.Country.html | 18 +- ...eIdStandardResponse.Location.TimeZone.html | 18 +- .../PhoneIdStandardResponse.Location.html | 18 +- ...onse.Numbering.CleansingNumber.Number.html | 22 +- ...ardResponse.Numbering.CleansingNumber.html | 18 +- ...dardResponse.Numbering.OriginalNumber.html | 18 +- .../PhoneIdStandardResponse.Numbering.html | 18 +- .../PhoneIdStandardResponse.PhoneType.html | 18 +- .../PhoneIdStandardResponse.Status.html | 18 +- .../class-use/PhoneIdStandardResponse.html | 18 +- .../phoneid/response/package-frame.html | 4 +- .../phoneid/response/package-summary.html | 213 +++-- .../phoneid/response/package-tree.html | 11 +- .../phoneid/response/package-use.html | 207 +++-- doc/com/telesign/response/ResponseTest.html | 286 +++++++ .../response/class-use/ResponseTest.html | 115 +++ doc/com/telesign/response/package-frame.html | 19 + .../telesign/response/package-summary.html | 135 ++++ doc/com/telesign/response/package-tree.html | 128 +++ doc/com/telesign/response/package-use.html | 115 +++ doc/com/telesign/util/PhoneUtil.html | 40 +- doc/com/telesign/util/TeleSignRequest.html | 499 +++++++++--- .../telesign/util/class-use/PhoneUtil.html | 9 +- .../util/class-use/TeleSignRequest.html | 9 +- doc/com/telesign/util/package-frame.html | 4 +- doc/com/telesign/util/package-summary.html | 26 +- doc/com/telesign/util/package-tree.html | 11 +- doc/com/telesign/util/package-use.html | 9 +- doc/com/telesign/verify/Verify.html | 278 ++++--- doc/com/telesign/verify/class-use/Verify.html | 9 +- doc/com/telesign/verify/package-frame.html | 4 +- doc/com/telesign/verify/package-summary.html | 28 +- doc/com/telesign/verify/package-tree.html | 11 +- doc/com/telesign/verify/package-use.html | 9 +- .../verify/response/VerifyResponse.Error.html | 38 +- .../response/VerifyResponse.Status.html | 61 +- .../response/VerifyResponse.Verify.html | 50 +- .../verify/response/VerifyResponse.html | 119 +-- .../class-use/VerifyResponse.Error.html | 18 +- .../class-use/VerifyResponse.Status.html | 18 +- .../class-use/VerifyResponse.Verify.html | 18 +- .../response/class-use/VerifyResponse.html | 60 +- .../verify/response/package-frame.html | 4 +- .../verify/response/package-summary.html | 39 +- .../verify/response/package-tree.html | 11 +- .../telesign/verify/response/package-use.html | 37 +- doc/constant-values.html | 9 +- doc/copyright.html | 38 + doc/deprecated-list.html | 6 +- doc/help-doc.html | 13 +- doc/index-files/index-1.html | 35 +- doc/index-files/index-10.html | 91 ++- doc/index-files/index-11.html | 71 +- doc/index-files/index-12.html | 275 +------ doc/index-files/index-13.html | 63 +- doc/index-files/index-14.html | 367 +++++++-- doc/index-files/index-15.html | 95 ++- doc/index-files/index-16.html | 170 +++- doc/index-files/index-17.html | 89 +- doc/index-files/index-18.html | 79 +- doc/index-files/index-19.html | 155 ++++ doc/index-files/index-2.html | 155 +--- doc/index-files/index-20.html | 135 ++++ doc/index-files/index-3.html | 318 +++++++- doc/index-files/index-4.html | 89 +- doc/index-files/index-5.html | 45 +- doc/index-files/index-6.html | 35 +- doc/index-files/index-7.html | 52 +- doc/index-files/index-8.html | 51 +- doc/index-files/index-9.html | 65 +- doc/index.html | 2 +- doc/overview-frame.html | 5 +- doc/overview-summary.html | 55 +- doc/overview-tree.html | 11 +- .../com/telesign/phoneid/PhoneId.html | 228 ++++++ .../PhoneIdContactResponse.Contact.html | 314 ++++++++ .../PhoneIdContactResponse.Error.html | 314 ++++++++ ...dContactResponse.Location.Coordinates.html | 314 ++++++++ ...oneIdContactResponse.Location.Country.html | 314 ++++++++ ...neIdContactResponse.Location.TimeZone.html | 314 ++++++++ .../PhoneIdContactResponse.Location.html | 314 ++++++++ ...onse.Numbering.CleansingNumber.Number.html | 314 ++++++++ ...actResponse.Numbering.CleansingNumber.html | 314 ++++++++ ...tactResponse.Numbering.OriginalNumber.html | 314 ++++++++ .../PhoneIdContactResponse.Numbering.html | 314 ++++++++ .../PhoneIdContactResponse.PhoneType.html | 314 ++++++++ .../PhoneIdContactResponse.Status.html | 314 ++++++++ .../response/PhoneIdContactResponse.html | 314 ++++++++ .../response/PhoneIdLiveResponse.Error.html | 302 +++++++ .../response/PhoneIdLiveResponse.Live.html | 302 +++++++ ...neIdLiveResponse.Location.Coordinates.html | 302 +++++++ .../PhoneIdLiveResponse.Location.Country.html | 302 +++++++ ...PhoneIdLiveResponse.Location.TimeZone.html | 302 +++++++ .../PhoneIdLiveResponse.Location.html | 302 +++++++ ...onse.Numbering.CleansingNumber.Number.html | 302 +++++++ ...iveResponse.Numbering.CleansingNumber.html | 302 +++++++ ...LiveResponse.Numbering.OriginalNumber.html | 302 +++++++ .../PhoneIdLiveResponse.Numbering.html | 302 +++++++ .../PhoneIdLiveResponse.PhoneType.html | 302 +++++++ .../response/PhoneIdLiveResponse.Status.html | 302 +++++++ .../phoneid/response/PhoneIdLiveResponse.html | 302 +++++++ .../response/PhoneIdScoreResponse.Error.html | 220 +++++ ...onse.Numbering.CleansingNumber.Number.html | 220 +++++ ...oreResponse.Numbering.CleansingNumber.html | 220 +++++ ...coreResponse.Numbering.OriginalNumber.html | 220 +++++ .../PhoneIdScoreResponse.Numbering.html | 220 +++++ .../PhoneIdScoreResponse.PhoneType.html | 220 +++++ .../response/PhoneIdScoreResponse.Risk.html | 220 +++++ .../response/PhoneIdScoreResponse.Status.html | 220 +++++ .../response/PhoneIdScoreResponse.html | 220 +++++ .../PhoneIdStandardResponse.Error.html | 279 +++++++ ...StandardResponse.Location.Coordinates.html | 279 +++++++ ...neIdStandardResponse.Location.Country.html | 279 +++++++ ...eIdStandardResponse.Location.TimeZone.html | 279 +++++++ .../PhoneIdStandardResponse.Location.html | 279 +++++++ ...onse.Numbering.CleansingNumber.Number.html | 279 +++++++ ...ardResponse.Numbering.CleansingNumber.html | 279 +++++++ ...dardResponse.Numbering.OriginalNumber.html | 279 +++++++ .../PhoneIdStandardResponse.Numbering.html | 279 +++++++ .../PhoneIdStandardResponse.PhoneType.html | 279 +++++++ .../PhoneIdStandardResponse.Status.html | 279 +++++++ .../response/PhoneIdStandardResponse.html | 279 +++++++ doc/src-html/com/telesign/util/PhoneUtil.html | 140 ++++ .../com/telesign/util/TeleSignRequest.html | 456 +++++++++++ doc/src-html/com/telesign/verify/Verify.html | 302 +++++++ .../verify/response/VerifyResponse.Error.html | 149 ++++ .../response/VerifyResponse.Status.html | 149 ++++ .../response/VerifyResponse.Verify.html | 149 ++++ .../verify/response/VerifyResponse.html | 149 ++++ overview.html | 10 + src/com/telesign/phoneid/PhoneId.java | 165 ++-- src/com/telesign/phoneid/package.html | 21 + .../response/PhoneIdContactResponse.java | 172 +++- .../phoneid/response/PhoneIdLiveResponse.java | 163 +++- .../response/PhoneIdScoreResponse.java | 107 ++- .../response/PhoneIdStandardResponse.java | 152 +++- .../telesign/phoneid/response/package.html | 8 + src/com/telesign/util/PhoneUtil.java | 114 +-- src/com/telesign/util/TeleSignRequest.java | 758 +++++++++++------- src/com/telesign/util/package.html | 8 + src/com/telesign/verify/Verify.java | 260 +++--- src/com/telesign/verify/package.html | 13 + .../verify/response/VerifyResponse.java | 61 +- src/com/telesign/verify/response/package.html | 8 + 255 files changed, 24884 insertions(+), 3858 deletions(-) create mode 100644 .classpath create mode 100644 .project create mode 100644 ant.properties create mode 100644 bin/com/telesign/phoneid/package.html create mode 100644 bin/com/telesign/phoneid/response/package.html create mode 100644 bin/com/telesign/util/package.html create mode 100644 bin/com/telesign/verify/package.html create mode 100644 bin/com/telesign/verify/response/package.html create mode 100644 build.xml create mode 100644 doc/com/telesign/PhoneIdTest.html create mode 100644 doc/com/telesign/TeleSignRequestTest.html create mode 100644 doc/com/telesign/VerifyTest.html create mode 100644 doc/com/telesign/class-use/PhoneIdTest.html create mode 100644 doc/com/telesign/class-use/TeleSignRequestTest.html create mode 100644 doc/com/telesign/class-use/VerifyTest.html create mode 100644 doc/com/telesign/package-frame.html create mode 100644 doc/com/telesign/package-summary.html create mode 100644 doc/com/telesign/package-tree.html create mode 100644 doc/com/telesign/package-use.html create mode 100644 doc/com/telesign/response/ResponseTest.html create mode 100644 doc/com/telesign/response/class-use/ResponseTest.html create mode 100644 doc/com/telesign/response/package-frame.html create mode 100644 doc/com/telesign/response/package-summary.html create mode 100644 doc/com/telesign/response/package-tree.html create mode 100644 doc/com/telesign/response/package-use.html create mode 100644 doc/copyright.html create mode 100644 doc/index-files/index-19.html create mode 100644 doc/index-files/index-20.html create mode 100644 doc/src-html/com/telesign/phoneid/PhoneId.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html create mode 100644 doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.html create mode 100644 doc/src-html/com/telesign/util/PhoneUtil.html create mode 100644 doc/src-html/com/telesign/util/TeleSignRequest.html create mode 100644 doc/src-html/com/telesign/verify/Verify.html create mode 100644 doc/src-html/com/telesign/verify/response/VerifyResponse.Error.html create mode 100644 doc/src-html/com/telesign/verify/response/VerifyResponse.Status.html create mode 100644 doc/src-html/com/telesign/verify/response/VerifyResponse.Verify.html create mode 100644 doc/src-html/com/telesign/verify/response/VerifyResponse.html create mode 100644 overview.html create mode 100644 src/com/telesign/phoneid/package.html create mode 100644 src/com/telesign/phoneid/response/package.html create mode 100644 src/com/telesign/util/package.html create mode 100644 src/com/telesign/verify/package.html create mode 100644 src/com/telesign/verify/response/package.html diff --git a/.classpath b/.classpath new file mode 100644 index 0000000..2589b1f --- /dev/null +++ b/.classpath @@ -0,0 +1,16 @@ + + + + + + + + + + + + + + + + diff --git a/.project b/.project new file mode 100644 index 0000000..b3b0fd7 --- /dev/null +++ b/.project @@ -0,0 +1,17 @@ + + + java_telesign + + + + + + org.eclipse.jdt.core.javabuilder + + + + + + org.eclipse.jdt.core.javanature + + diff --git a/ant.properties b/ant.properties new file mode 100644 index 0000000..2778706 --- /dev/null +++ b/ant.properties @@ -0,0 +1,7 @@ +bin-dir=bin +doc-dir=doc +jel-dir=jel +lib-dir=libs +src-dir=src +test-dir=test +javadoc-access=public \ No newline at end of file diff --git a/bin/com/telesign/phoneid/package.html b/bin/com/telesign/phoneid/package.html new file mode 100644 index 0000000..6798634 --- /dev/null +++ b/bin/com/telesign/phoneid/package.html @@ -0,0 +1,21 @@ + + + +

+ Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service. +

+

+ The PhoneID web service retrieves information about a specified phone number. This includes the it's: +

+ +

+ Using this service, you can decide what types of phone numbers to accept from users, + or determine whether the numbers that users submit coincide with the address information provided. +

+ + \ No newline at end of file diff --git a/bin/com/telesign/phoneid/response/package.html b/bin/com/telesign/phoneid/response/package.html new file mode 100644 index 0000000..af0c397 --- /dev/null +++ b/bin/com/telesign/phoneid/response/package.html @@ -0,0 +1,8 @@ + + + +

+ Contains a set of classes that represent TeleSign server response objects—one for each of the PhoneID web services. +

+ + \ No newline at end of file diff --git a/bin/com/telesign/util/package.html b/bin/com/telesign/util/package.html new file mode 100644 index 0000000..513635a --- /dev/null +++ b/bin/com/telesign/util/package.html @@ -0,0 +1,8 @@ + + + +

+ Contains a class for normalizing a phone number, and a class that represents a TeleSign service request object. +

+ + \ No newline at end of file diff --git a/bin/com/telesign/verify/package.html b/bin/com/telesign/verify/package.html new file mode 100644 index 0000000..8e725d2 --- /dev/null +++ b/bin/com/telesign/verify/package.html @@ -0,0 +1,13 @@ + + + +

+ Contains the Verify class, which abstracts calls to the TeleSign Verify Web Service. +

+

+ The Phone Verify web service provides an identity verification solution that uses the telephone to deliver a one-time validation code to your end users. + Upon receiving this code, your users just type it into their computer and send it back to you (or to us if they dial it into their phone). + The validity of their identity is then determined by simply comparing the codes they return to the ones we send them—and a match is considered positive identification. +

+ + \ No newline at end of file diff --git a/bin/com/telesign/verify/response/package.html b/bin/com/telesign/verify/response/package.html new file mode 100644 index 0000000..df62dfa --- /dev/null +++ b/bin/com/telesign/verify/response/package.html @@ -0,0 +1,8 @@ + + + +

+ Contains a class that represents the TeleSign server response object for the Phone Verify web service. +

+ + \ No newline at end of file diff --git a/build.xml b/build.xml new file mode 100644 index 0000000..81702cf --- /dev/null +++ b/build.xml @@ -0,0 +1,33 @@ + + + + + + + + + + +
+
+ + + + \ No newline at end of file diff --git a/doc/allclasses-frame.html b/doc/allclasses-frame.html index 26b7eec..2dab0f6 100644 --- a/doc/allclasses-frame.html +++ b/doc/allclasses-frame.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/doc/allclasses-noframe.html b/doc/allclasses-noframe.html index 9748fd7..62b586b 100644 --- a/doc/allclasses-noframe.html +++ b/doc/allclasses-noframe.html @@ -2,9 +2,9 @@ - + All Classes - + diff --git a/doc/com/telesign/PhoneIdTest.html b/doc/com/telesign/PhoneIdTest.html new file mode 100644 index 0000000..5605bb4 --- /dev/null +++ b/doc/com/telesign/PhoneIdTest.html @@ -0,0 +1,390 @@ + + + + + +PhoneIdTest + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.telesign
+

Class PhoneIdTest

+
+
+ +
+
    +
  • +
    +
    +
    public class PhoneIdTest
+extends java.lang.Object
    +
    Copyright (c) TeleSign Corporation 2012. + License: MIT + Support email address "support@telesign.com" + Author: jweatherford
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Field Summary

      + + + + + + + + + + + + + + + + + + +
      Fields 
      Modifier and TypeField and Description
      java.lang.StringCUSTOMER_ID 
      java.lang.StringPHONE_NUMBER 
      java.lang.StringSECRET_KEY 
      +
      • +
    + +
      +
    • + + +

      Constructor Summary

      + + + + + + + + +
      Constructors 
      Constructor and Description
      PhoneIdTest() 
      +
      • +
    + + +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        PhoneIdTest

        +
        public PhoneIdTest()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        phoneIdError

        +
        public void phoneIdError()
        +
        • +
      + + + +
        +
      • +

        phoneIdStandard

        +
        public void phoneIdStandard()
        +
        • +
      + + + +
        +
      • +

        phoneIdScore

        +
        public void phoneIdScore()
        +
        • +
      + + + +
        +
      • +

        phoneIdContact

        +
        public void phoneIdContact()
        +
        • +
      + + + +
        +
      • +

        phoneIdLiveDummy

        +
        public void phoneIdLiveDummy()
        +
        • +
      + + + +
        +
      • +

        phoneIdLiveReal

        +
        public void phoneIdLiveReal()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/com/telesign/TeleSignRequestTest.html b/doc/com/telesign/TeleSignRequestTest.html new file mode 100644 index 0000000..566262b --- /dev/null +++ b/doc/com/telesign/TeleSignRequestTest.html @@ -0,0 +1,286 @@ + + + + + +TeleSignRequestTest + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + +
+
com.telesign
+

Class TeleSignRequestTest

+
+
+ +
+
    +
  • +
    +
    +
    public class TeleSignRequestTest
+extends java.lang.Object
    +
    Copyright (c) TeleSign Corporation 2012. + License: MIT + Support email address "support@telesign.com" + Author: jweatherford
    +
    • +
+
+
+
    +
  • + + + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      voidaddHeaderTest() 
      voidaddParameterTest() 
      voidrequestCreation() 
      +
        +
      • + + +

        Methods inherited from class java.lang.Object

        +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
        • +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        TeleSignRequestTest

        +
        public TeleSignRequestTest()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        requestCreation

        +
        public void requestCreation()
        +
        • +
      + + + +
        +
      • +

        addParameterTest

        +
        public void addParameterTest()
        +
        • +
      + + + +
        +
      • +

        addHeaderTest

        +
        public void addHeaderTest()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+
    +
  • Summary: 
    • +
  • Nested | 
    • +
  • Field | 
    • +
  • Constr | 
    • +
  • Method
    • +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/VerifyTest.html b/doc/com/telesign/VerifyTest.html new file mode 100644 index 0000000..36147d7 --- /dev/null +++ b/doc/com/telesign/VerifyTest.html @@ -0,0 +1,377 @@ + + + + + +VerifyTest + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
com.telesign
+

Class VerifyTest

+
+
+ +
+
    +
  • +
    +
    +
    public class VerifyTest
+extends java.lang.Object
    +
    Copyright (c) TeleSign Corporation 2012. + License: MIT + Support email address "support@telesign.com" + Author: jweatherford
    +
    • +
+
+
+ +
+
+
    +
  • + + + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        VerifyTest

        +
        public VerifyTest()
        +
        • +
      +
      • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        verifyError

        +
        public void verifyError()
        +
        • +
      + + + +
        +
      • +

        verifyRequestCall

        +
        public void verifyRequestCall()
        +
        • +
      + + + +
        +
      • +

        verifyRequestSMS

        +
        public void verifyRequestSMS()
        +
        • +
      + + + +
        +
      • +

        verifyRequestCallwithResult

        +
        public void verifyRequestCallwithResult()
        +
        • +
      + + + +
        +
      • +

        verifyRequestSMSwithResult

        +
        public void verifyRequestSMSwithResult()
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + diff --git a/doc/com/telesign/class-use/PhoneIdTest.html b/doc/com/telesign/class-use/PhoneIdTest.html new file mode 100644 index 0000000..53ac5d2 --- /dev/null +++ b/doc/com/telesign/class-use/PhoneIdTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.telesign.PhoneIdTest + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.telesign.PhoneIdTest

+
+
No usage of com.telesign.PhoneIdTest
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/class-use/TeleSignRequestTest.html b/doc/com/telesign/class-use/TeleSignRequestTest.html new file mode 100644 index 0000000..ad2af62 --- /dev/null +++ b/doc/com/telesign/class-use/TeleSignRequestTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.telesign.TeleSignRequestTest + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.telesign.TeleSignRequestTest

+
+
No usage of com.telesign.TeleSignRequestTest
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/class-use/VerifyTest.html b/doc/com/telesign/class-use/VerifyTest.html new file mode 100644 index 0000000..8f28f40 --- /dev/null +++ b/doc/com/telesign/class-use/VerifyTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.telesign.VerifyTest + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Class
com.telesign.VerifyTest

+
+
No usage of com.telesign.VerifyTest
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/package-frame.html b/doc/com/telesign/package-frame.html new file mode 100644 index 0000000..29b7afc --- /dev/null +++ b/doc/com/telesign/package-frame.html @@ -0,0 +1,21 @@ + + + + + +com.telesign + + + + +

com.telesign

+
+

Classes

+ +
+ + diff --git a/doc/com/telesign/package-summary.html b/doc/com/telesign/package-summary.html new file mode 100644 index 0000000..36f1273 --- /dev/null +++ b/doc/com/telesign/package-summary.html @@ -0,0 +1,147 @@ + + + + + +com.telesign + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Package com.telesign

+
+
+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/package-tree.html b/doc/com/telesign/package-tree.html new file mode 100644 index 0000000..4ae1dfa --- /dev/null +++ b/doc/com/telesign/package-tree.html @@ -0,0 +1,130 @@ + + + + + +com.telesign Class Hierarchy + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Hierarchy For Package com.telesign

+Package Hierarchies: + +
+
+

Class Hierarchy

+ +
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/package-use.html b/doc/com/telesign/package-use.html new file mode 100644 index 0000000..44ae5c7 --- /dev/null +++ b/doc/com/telesign/package-use.html @@ -0,0 +1,115 @@ + + + + + +Uses of Package com.telesign + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+ + +
+ +
+

Uses of Package
com.telesign

+
+
No usage of com.telesign
+ +
+ + + + + +
+
+ + + +
+ +
+ + +
+ + + diff --git a/doc/com/telesign/phoneid/PhoneId.html b/doc/com/telesign/phoneid/PhoneId.html index 74d5e64..fc1bcce 100644 --- a/doc/com/telesign/phoneid/PhoneId.html +++ b/doc/com/telesign/phoneid/PhoneId.html @@ -2,9 +2,9 @@ - + PhoneId - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/package-frame.html b/doc/com/telesign/phoneid/package-frame.html index d0a3f15..c68c4df 100644 --- a/doc/com/telesign/phoneid/package-frame.html +++ b/doc/com/telesign/phoneid/package-frame.html @@ -2,9 +2,9 @@ - + com.telesign.phoneid - + diff --git a/doc/com/telesign/phoneid/package-summary.html b/doc/com/telesign/phoneid/package-summary.html index 8741347..eea9037 100644 --- a/doc/com/telesign/phoneid/package-summary.html +++ b/doc/com/telesign/phoneid/package-summary.html @@ -2,9 +2,9 @@ - + com.telesign.phoneid - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/package-tree.html b/doc/com/telesign/phoneid/package-tree.html index f58e289..3e5e6e7 100644 --- a/doc/com/telesign/phoneid/package-tree.html +++ b/doc/com/telesign/phoneid/package-tree.html @@ -2,9 +2,9 @@ - + com.telesign.phoneid Class Hierarchy - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Uses of Package

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html index d35249f..c3f494f 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Contact - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdCont

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Contact
        • @@ -101,7 +101,8 @@

        Class PhoneIdCont 

        public static class PhoneIdContactResponse.Contact
-extends java.lang.Object
        +extends Object +
        An object that describes data associated with the contact specified in the request.

    @@ -121,44 +122,64 @@

    Field Summary

    Field and Description -java.lang.String -address1  +String +address1 +
    A string that indicates the first line of the contact’s street address.
    + -java.lang.String -address2  +String +address2 +
    A string that indicates the second line of the contact’s street address.
    + -java.lang.String -address3  +String +address3 +
    A string that indicates the third line of the contact’s street address.
    + -java.lang.String -address4  +String +address4 +
    A string that indicates the fourth line of the contact’s street address.
    + -java.lang.String -city  +String +city +
    A string that indicates the city in which the contact is located.
    + -java.lang.String -country  +String +country +
    A string that indicates the country in which the contact is located.
    + -java.lang.String -firstname  +String +firstname +
    A string that indicates the contact’s first name or given name.
    + -java.lang.String -lastname  +String +lastname +
    A string that indicates the contact’s last name or family name.
    + -java.lang.String -state_province  +String +state_province +
    A string that indicates the state, province, or region in which the contact is located.
    + -java.lang.String -zip_postal_code  +String +zip_postal_code +
    A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only).
    + @@ -187,11 +208,11 @@

    Constructor Summary

    Method Summary

    @@ -207,85 +228,94 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      firstname

      -
      public java.lang.String firstname
      +

      address1

      +
      public String address1
      +
      A string that indicates the first line of the contact’s street address.
    - +
    • -

      lastname

      -
      public java.lang.String lastname
      +

      address2

      +
      public String address2
      +
      A string that indicates the second line of the contact’s street address.
    - +
    • -

      address1

      -
      public java.lang.String address1
      +

      address3

      +
      public String address3
      +
      A string that indicates the third line of the contact’s street address.
    - +
    • -

      address2

      -
      public java.lang.String address2
      +

      address4

      +
      public String address4
      +
      A string that indicates the fourth line of the contact’s street address.
    - +
    • -

      address3

      -
      public java.lang.String address3
      +

      city

      +
      public String city
      +
      A string that indicates the city in which the contact is located.
    - +
    • -

      address4

      -
      public java.lang.String address4
      +

      country

      +
      public String country
      +
      A string that indicates the country in which the contact is located.
    - +
    • -

      city

      -
      public java.lang.String city
      +

      firstname

      +
      public String firstname
      +
      A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names.
    - +
    • -

      state_province

      -
      public java.lang.String state_province
      +

      lastname

      +
      public String lastname
      +
      A string that indicates the contact’s last name or family name. If that contact is a business, this value is null.
    - +
    • -

      country

      -
      public java.lang.String country
      +

      state_province

      +
      public String state_province
      +
      A string that indicates the state, province, or region in which the contact is located.
    @@ -294,7 +324,8 @@

    country

     @@ -333,10 +364,10 @@

    PhoneIdContactResponse.Contact

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -381,5 +412,6 @@

      PhoneIdContactResponse.Contact

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html index a93b06d..924d522 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Error - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdContac

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Error
        • @@ -101,7 +101,8 @@

        Class PhoneIdContac 

        public static class PhoneIdContactResponse.Error
-extends java.lang.Object
        +extends Object +
        An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    + -java.lang.String -description  +String +description +
    A string that describes the type of error that occurred.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned.
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdContactResponse.Error

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdContactResponse.Error

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html index c07d963..91f033f 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Location.Coordinates - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Clas

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
        • @@ -101,7 +101,8 @@

        Clas 

        public static class PhoneIdContactResponse.Location.Coordinates
-extends java.lang.Object
        +extends Object +
        An object containing details about the geographical coordinates of the location where the phone number is registered.

    @@ -122,11 +123,15 @@

    Field Summary

    double -latitude  +latitude +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places.
    + double -longitude  +longitude +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • latitude

    public double latitude
    +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264.
    • @@ -191,6 +197,7 @@

    latitude

  • longitude

    public double longitude
    +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    • @@ -229,10 +236,10 @@

    PhoneIdContactResponse.Location.Coordinates

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -264,7 +271,7 @@

      PhoneIdContactResponse.Location.Coordinates

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdContactResponse.Location.Coordinates

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html index 70f5382..6cbee65 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Location.Country - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class Ph

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
        • @@ -101,7 +101,8 @@

        Class Ph 

        public static class PhoneIdContactResponse.Location.Country
-extends java.lang.Object
        +extends Object +
        An object containing details about the country associated with the phone number.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -iso2  +String +iso2 +
    The ISO 3166-1 2-letter Country Code associated with the phone number.
    + -java.lang.String -iso3  +String +iso3 +
    The ISO 3166-1 3-letter Country Code associated with the phone number
    + -java.lang.String -name  +String +name +
    The Country Name associated with phone number.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -185,7 +192,8 @@

    Field Detail

    • iso2

      -
      public java.lang.String iso2
      +
      public String iso2
      +
      The ISO 3166-1 2-letter Country Code associated with the phone number.
    @@ -194,7 +202,8 @@

    iso2

     @@ -203,7 +212,8 @@

    iso3

     @@ -242,10 +252,10 @@

    PhoneIdContactResponse.Location.Country

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdContactResponse.Location.Country

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html index bbaa9a0..f4b21a5 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Location.TimeZone - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class P

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
        • @@ -101,7 +101,8 @@

        Class P 

        public static class PhoneIdContactResponse.Location.TimeZone
-extends java.lang.Object
        +extends Object +
        An object containing details about the Time Zone associated with the phone number.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -name  +String +name +
    A string identifying the Time Zone Name (TZ) associated with the phone number (U.S.
    + -java.lang.String -utc_offset_max  +String +utc_offset_max +
    For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number.
    + -java.lang.String -utc_offset_min  +String +utc_offset_min +
    For U.S.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      utc_offset_min

      -
      public java.lang.String utc_offset_min
      +

      name

      +
      public String name
      +
      A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles".
    - +
    • -

      name

      -
      public java.lang.String name
      +

      utc_offset_max

      +
      public String utc_offset_max
      +
      For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min.
    - +
    • -

      utc_offset_max

      -
      public java.lang.String utc_offset_max
      +

      utc_offset_min

      +
      public String utc_offset_min
      +
      For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number.
    @@ -242,10 +252,10 @@

    PhoneIdContactResponse.Location.TimeZone

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdContactResponse.Location.TimeZone

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html index 0eba974..3339f87 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Location - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdCon

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Location
        • @@ -101,7 +101,9 @@

        Class PhoneIdCon 

        public static class PhoneIdContactResponse.Location
-extends java.lang.Object
        +extends Object +
        An object containing geographical location information associated with the phone number. + Note: Location refers to the place where the phone is registered, not to where it actually is at the time of this request.

    @@ -122,15 +124,21 @@

    Nested Class Summary

    static class  -PhoneIdContactResponse.Location.Coordinates  +PhoneIdContactResponse.Location.Coordinates +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    + static class  -PhoneIdContactResponse.Location.Country  +PhoneIdContactResponse.Location.Country +
    An object containing details about the country associated with the phone number.
    + static class  -PhoneIdContactResponse.Location.TimeZone  +PhoneIdContactResponse.Location.TimeZone +
    An object containing details about the Time Zone associated with the phone number.
    + @@ -148,36 +156,52 @@

    Field Summary

    Field and Description -java.lang.String -city  +String +city +
    A string specifying the name of the city associated with the phone number.
    + PhoneIdContactResponse.Location.Coordinates -coordinates  +coordinates +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    + PhoneIdContactResponse.Location.Country -country  +country +
    An object containing details about the country associated with the phone number.
    + -java.lang.String -county  +String +county +
    A string specifying the name of the County (or Parish) associated with the phone number (U.S.
    + -java.lang.String -metro_code  +String +metro_code +
    A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S.
    + -java.lang.String -state  +String +state +
    The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    + PhoneIdContactResponse.Location.TimeZone -time_zone  +time_zone +
    An object containing details about the Time Zone associated with the phone number.
    + -java.lang.String -zip  +String +zip +
    The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S.
    + @@ -206,11 +230,11 @@

    Constructor Summary

    Method Summary

    @@ -226,76 +250,84 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      county

      -
      public java.lang.String county
      +

      city

      +
      public String city
      +
      A string specifying the name of the city associated with the phone number.
    - +
    • -

      city

      -
      public java.lang.String city
      +

      coordinates

      +
      public PhoneIdContactResponse.Location.Coordinates coordinates
      +
      An object containing details about the geographical coordinates of the location where the phone number is registered.
    - + - +
    • -

      zip

      -
      public java.lang.String zip
      +

      county

      +
      public String county
      +
      A string specifying the name of the County (or Parish) associated with the phone number (U.S. only).
    - +
    • -

      country

      -
      public PhoneIdContactResponse.Location.Country country
      +

      metro_code

      +
      public String metro_code
      +
      A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau.
    - + - + - +
    • -

      metro_code

      -
      public java.lang.String metro_code
      +

      zip

      +
      public String zip
      +
      The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only).
    @@ -334,10 +366,10 @@

    PhoneIdContactResponse.Location

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -382,5 +414,6 @@

      PhoneIdContactResponse.Location

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html index 73bb6cd..c4b9d6f 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Numbering.CleansingNumber.Number - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

        -
      • java.lang.Object
        • +
      • Object
        • com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
          • @@ -101,7 +101,8 @@ 


          public static class PhoneIdContactResponse.Numbering.CleansingNumber.Number
-extends java.lang.Object
          +extends Object +
          An object containing cleansing details about a phone number.

      @@ -122,23 +123,33 @@

      Field Summary

      int -cleansed_code  +cleansed_code +
      One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
      + -java.lang.String -country_code  +String +country_code +
      A 1, 2, or 3-digit number representing the Country Dialing Code.
      + int -max_length  +max_length +
      The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
      + int -min_length  +min_length +
      The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
      + -java.lang.String -phone_number  +String +phone_number +
      The Base Phone Number.
      + @@ -167,11 +178,11 @@

      Constructor Summary

      Method Summary

    @@ -187,13 +198,14 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      cleansed_code

      +
      public int cleansed_code
      +
      One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number).
    @@ -202,34 +214,38 @@

    phone_number

     - +
    • -

      min_length

      -
      public int min_length
      +

      max_length

      +
      public int max_length
      +
      The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      max_length

      -
      public int max_length
      +

      min_length

      +
      public int min_length
      +
      The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      cleansed_code

      -
      public int cleansed_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -268,10 +284,10 @@

    PhoneIdContactResponse.Numbering.CleansingNumber.Number

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -303,7 +319,7 @@

      PhoneIdContactResponse.Numbering.CleansingNumber.Number

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -316,5 +332,6 @@

      PhoneIdContactResponse.Numbering.CleansingNumber.Number

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html index 4d09635..dee9ba6 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Numbering.CleansingNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    @@ -194,22 +201,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -248,10 +257,10 @@

    PhoneIdContactResponse.Numbering.CleansingNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -296,5 +305,6 @@

      PhoneIdContactResponse.Numbering.CleansingNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html index 8081fb8..f81823a 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Numbering.OriginalNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
        • @@ -101,7 +101,8 @@ 


        public static class PhoneIdContactResponse.Numbering.OriginalNumber
-extends java.lang.Object
        +extends Object +
        An object containing details about the original phone number passed to TeleSign’s PhoneID API.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -complete_phone_number  +String +complete_phone_number +
    The Base Phone Number prefixed with the Country Dialing Code.
    + -java.lang.String -country_code  +String +country_code +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    + -java.lang.String -phone_number  +String +phone_number +
    The Base Phone Number.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      complete_phone_number

      +
      public String complete_phone_number
      +
      The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI.
    - +
    • -

      complete_phone_number

      -
      public java.lang.String complete_phone_number
      +

      country_code

      +
      public String country_code
      +
      A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44.
    - +
    • -

      country_code

      -
      public java.lang.String country_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -242,10 +252,10 @@

    PhoneIdContactResponse.Numbering.OriginalNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -277,7 +287,7 @@

      PhoneIdContactResponse.Numbering.OriginalNumber

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdContactResponse.Numbering.OriginalNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html index 2f82580..594d374 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Numbering - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdCo

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
        • @@ -101,7 +101,8 @@

        Class PhoneIdCo 

        public static class PhoneIdContactResponse.Numbering
-extends java.lang.Object
        +extends Object +
        An object containing details about the numbering attributes of the specified phone number.

    @@ -122,11 +123,15 @@

    Nested Class Summary

    static class  -PhoneIdContactResponse.Numbering.CleansingNumber  +PhoneIdContactResponse.Numbering.CleansingNumber +
    An object containing details about how the phone number was cleansed.
    + static class  -PhoneIdContactResponse.Numbering.OriginalNumber  +PhoneIdContactResponse.Numbering.OriginalNumber +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -145,11 +150,15 @@

    Field Summary

    PhoneIdContactResponse.Numbering.CleansingNumber -cleansing  +cleansing +
    An object containing details about how the phone number was cleansed.
    + PhoneIdContactResponse.Numbering.OriginalNumber -original  +original +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -178,11 +187,11 @@

    Constructor Summary

    Method Summary

    @@ -198,22 +207,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -252,10 +263,10 @@

    PhoneIdContactResponse.Numbering

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -300,5 +311,6 @@

      PhoneIdContactResponse.Numbering

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html index 3dfc2c0..6809d11 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.PhoneType - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdCo

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
        • @@ -101,7 +101,8 @@

        Class PhoneIdCo 

        public static class PhoneIdContactResponse.PhoneType
-extends java.lang.Object
        +extends Object +
        An object containing details about the phone type.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    One of the Phone Type Codes."
    + -java.lang.String -description  +String +description +
    A description of the phone type.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    One of the Phone Type Codes."
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdContactResponse.PhoneType

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdContactResponse.PhoneType

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html index 45521cd..3c522af 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse.Status - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdConta

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse.Status
        • @@ -101,7 +101,8 @@

        Class PhoneIdConta 

        public static class PhoneIdContactResponse.Status
-extends java.lang.Object
        +extends Object +
        An object containing details about the request status.

    @@ -122,15 +123,21 @@

    Field Summary

    int -code  +code +
    One of the Transaction Status Codes.
    + -java.lang.String -description  +String +description +
    A descriptionm of the transaction status.
    + -java.lang.String -updated_on  +String +updated_on +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      updated_on

      -
      public java.lang.String updated_on
      +

      code

      +
      public int code
      +
      One of the Transaction Status Codes.
    - +
    • -

      code

      -
      public int code
      +

      description

      +
      public String description
      +
      A descriptionm of the transaction status.
    - +
    • -

      description

      -
      public java.lang.String description
      +

      updated_on

      +
      public String updated_on
      +
      An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    @@ -242,10 +252,10 @@

    PhoneIdContactResponse.Status

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdContactResponse.Status

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.html b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.html index 7b4bf36..f57d390 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdContactResponse.html +++ b/doc/com/telesign/phoneid/response/PhoneIdContactResponse.html @@ -2,9 +2,9 @@ - + PhoneIdContactResponse - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -84,7 +84,7 @@

      Class PhoneIdContactRespo

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdContactResponse
        • @@ -97,14 +97,8 @@

        Class PhoneIdContactRespo 

        public class PhoneIdContactResponse
-extends java.lang.Object
        -
        Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.contact() request - - Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The PhoneIdContactResponse class encapsulates all of the information returned from a call to the PhoneID Contact web service.

    @@ -125,27 +119,39 @@

    Nested Class Summary

    static class  -PhoneIdContactResponse.Contact  +PhoneIdContactResponse.Contact +
    An object that describes data associated with the contact specified in the request.
    + static class  -PhoneIdContactResponse.Error  +PhoneIdContactResponse.Error +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    + static class  -PhoneIdContactResponse.Location  +PhoneIdContactResponse.Location +
    An object containing geographical location information associated with the phone number.
    + static class  -PhoneIdContactResponse.Numbering  +PhoneIdContactResponse.Numbering +
    An object containing details about the numbering attributes of the specified phone number.
    + static class  -PhoneIdContactResponse.PhoneType  +PhoneIdContactResponse.PhoneType +
    An object containing details about the phone type.
    + static class  -PhoneIdContactResponse.Status  +PhoneIdContactResponse.Status +
    An object containing details about the request status.
    + @@ -164,43 +170,63 @@

    Field Summary

    PhoneIdContactResponse.Contact -contact  +contact +
    An object that describes data associated with the contact specified in the request.
    + PhoneIdContactResponse.Error[] -errors  +errors +
    An array of PhoneIdContactResponse.Error objects.
    + PhoneIdContactResponse.Location -location  +location +
    An object containing geographical location information associated with the phone number.
    + PhoneIdContactResponse.Numbering -numbering  +numbering +
    An object containing details about the numbering attributes of the specified phone number.
    + PhoneIdContactResponse.PhoneType -phone_type  +phone_type +
    An object that contains details about the phone type.
    + -java.lang.String -reference_id  +String +reference_id +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    + -java.lang.String -resource_uri  +String +resource_uri +
    A String containing the URI for accesses the PhoneID resource.
    + -java.lang.String -signature_string  +String +signature_string +
    A String containing the Signature, exactly as it was sent in the Request.
    + PhoneIdContactResponse.Status -status  +status +
    An object containing details about the request status.
    + -java.lang.String -sub_resource  +String +sub_resource +
    A String containing the name of the subresource that was accessed.
    + @@ -235,16 +261,18 @@

    Method Summary

    Method and Description -java.lang.String -toString()  +String +toString() +
    Converts a PhoneIdContactResponse object to its equivalent JSON format, using the Gson class library.
    + @@ -260,40 +288,44 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      reference_id

      -
      public java.lang.String reference_id
      +

      contact

      +
      public PhoneIdContactResponse.Contact contact
      +
      An object that describes data associated with the contact specified in the request.
    - + - +
    • -

      sub_resource

      -
      public java.lang.String sub_resource
      +

      location

      +
      public PhoneIdContactResponse.Location location
      +
      An object containing geographical location information associated with the phone number.
    - + @@ -303,51 +335,57 @@

    errors

  • phone_type

    public PhoneIdContactResponse.PhoneType phone_type
    +
    An object that contains details about the phone type.
    • - +
    • -

      signature_string

      -
      public java.lang.String signature_string
      +

      reference_id

      +
      public String reference_id
      +
      A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    - + - +
    • -

      numbering

      -
      public PhoneIdContactResponse.Numbering numbering
      +

      signature_string

      +
      public String signature_string
      +
      A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.
    - + - +
    • -

      contact

      -
      public PhoneIdContactResponse.Contact contact
      +

      sub_resource

      +
      public String sub_resource
      +
      A String containing the name of the subresource that was accessed. For example, "standard".
    @@ -381,11 +419,13 @@

    Method Detail

    • toString

      -
      public java.lang.String toString()
      +
      public String toString()
      +
      Converts a PhoneIdContactResponse object to its equivalent JSON format, using the Gson class library.
      Overrides:
      -
      toString in class java.lang.Object
      -
      +
      toString in class Object
      +
      Returns:
      A string containing the response from the TeleSign server, in JSON format.
      See Also:
      Object.toString(), +Gson
    @@ -407,10 +447,10 @@

    toString

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -455,5 +495,6 @@

      toString

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html index 5e48554..ee87e44 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Error - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdLiveRespo

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Error
        • @@ -101,7 +101,8 @@

        Class PhoneIdLiveRespo 

        public static class PhoneIdLiveResponse.Error
-extends java.lang.Object
        +extends Object +
        An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    + -java.lang.String -description  +String +description +
    A string that describes the type of error that occurred.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned.
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdLiveResponse.Error

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdLiveResponse.Error

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html index 60e83e2..88792c2 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Live - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdLiveRespon

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Live
        • @@ -101,7 +101,9 @@

        Class PhoneIdLiveRespon 

        public static class PhoneIdLiveResponse.Live
-extends java.lang.Object
        +extends Object +
        A JSON object containing details about a specified phone number’s state of operation. + Note: In the case where PhoneID Live is not supported for the specified phone number, the server returns a Live object that is null.

    @@ -121,20 +123,28 @@

    Field Summary

    Field and Description -java.lang.String -device_status  +String +device_status +
    A string indicating the current status of the phone equipment.
    + -java.lang.String -roaming  +String +roaming +
    A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area.
    + -java.lang.String -roaming_country  +String +roaming_country +
    The country in which the mobile device is roaming.
    + -java.lang.String -subscriber_status  +String +subscriber_status +
    A string indicating the current status of the subscriber’s phone number.
    + @@ -163,11 +173,11 @@

    Constructor Summary

    Method Summary

    @@ -183,40 +193,44 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      subscriber_status

      -
      public java.lang.String subscriber_status
      +

      device_status

      +
      public String device_status
      +
      A string indicating the current status of the phone equipment.
    - +
    • -

      device_status

      -
      public java.lang.String device_status
      +

      roaming

      +
      public String roaming
      +
      A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area.
    - +
    • -

      roaming

      -
      public java.lang.String roaming
      +

      roaming_country

      +
      public String roaming_country
      +
      The country in which the mobile device is roaming.
    - +
    • -

      roaming_country

      -
      public java.lang.String roaming_country
      +

      subscriber_status

      +
      public String subscriber_status
      +
      A string indicating the current status of the subscriber’s phone number.
    @@ -255,10 +269,10 @@

    PhoneIdLiveResponse.Live

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -303,5 +317,6 @@

      PhoneIdLiveResponse.Live

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html index 20695cd..a2202ff 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Location.Coordinates - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class P

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
        • @@ -101,7 +101,8 @@

        Class P 

        public static class PhoneIdLiveResponse.Location.Coordinates
-extends java.lang.Object
        +extends Object +
        An object containing details about the geographical coordinates of the location where the phone number is registered.

    @@ -122,11 +123,15 @@

    Field Summary

    double -latitude  +latitude +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places.
    + double -longitude  +longitude +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • latitude

    public double latitude
    +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264.
    • @@ -191,6 +197,7 @@

    latitude

  • longitude

    public double longitude
    +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    • @@ -229,10 +236,10 @@

    PhoneIdLiveResponse.Location.Coordinates

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdLiveResponse.Location.Coordinates

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html index e156e4f..4718093 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Location.Country - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class Phone

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
        • @@ -101,7 +101,8 @@

        Class Phone 

        public static class PhoneIdLiveResponse.Location.Country
-extends java.lang.Object
        +extends Object +
        An object containing details about the country associated with the phone number.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -iso2  +String +iso2 +
    The ISO 3166-1 2-letter Country Code associated with the phone number.
    + -java.lang.String -iso3  +String +iso3 +
    The ISO 3166-1 3-letter Country Code associated with the phone number
    + -java.lang.String -name  +String +name +
    The Country Name associated with phone number.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -185,7 +192,8 @@

    Field Detail

    • iso2

      -
      public java.lang.String iso2
      +
      public String iso2
      +
      The ISO 3166-1 2-letter Country Code associated with the phone number.
    @@ -194,7 +202,8 @@

    iso2

     @@ -203,7 +212,8 @@

    iso3

     @@ -242,10 +252,10 @@

    PhoneIdLiveResponse.Location.Country

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdLiveResponse.Location.Country

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html index 48f7ec7..69a2654 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Location.TimeZone - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class Phon

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
        • @@ -101,7 +101,8 @@

        Class Phon 

        public static class PhoneIdLiveResponse.Location.TimeZone
-extends java.lang.Object
        +extends Object +
        An object containing details about the Time Zone associated with the phone number.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -name  +String +name +
    A string identifying the Time Zone Name (TZ) associated with the phone number (U.S.
    + -java.lang.String -utc_offset_max  +String +utc_offset_max +
    For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number.
    + -java.lang.String -utc_offset_min  +String +utc_offset_min +
    For U.S.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      utc_offset_min

      -
      public java.lang.String utc_offset_min
      +

      name

      +
      public String name
      +
      A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles".
    - +
    • -

      name

      -
      public java.lang.String name
      +

      utc_offset_max

      +
      public String utc_offset_max
      +
      For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min.
    - +
    • -

      utc_offset_max

      -
      public java.lang.String utc_offset_max
      +

      utc_offset_min

      +
      public String utc_offset_min
      +
      For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number.
    @@ -242,10 +252,10 @@

    PhoneIdLiveResponse.Location.TimeZone

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdLiveResponse.Location.TimeZone

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html index 49d41e4..128a36f 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Location - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdLiveRe

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Location
        • @@ -101,7 +101,9 @@

        Class PhoneIdLiveRe 

        public static class PhoneIdLiveResponse.Location
-extends java.lang.Object
        +extends Object +
        An object containing geographical location information associated with the phone number. + Note: Location refers to the place where the phone is registered, not to where it actually is at the time of this request.

    @@ -122,15 +124,21 @@

    Nested Class Summary

    static class  -PhoneIdLiveResponse.Location.Coordinates  +PhoneIdLiveResponse.Location.Coordinates +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    + static class  -PhoneIdLiveResponse.Location.Country  +PhoneIdLiveResponse.Location.Country +
    An object containing details about the country associated with the phone number.
    + static class  -PhoneIdLiveResponse.Location.TimeZone  +PhoneIdLiveResponse.Location.TimeZone +
    An object containing details about the Time Zone associated with the phone number.
    + @@ -148,36 +156,52 @@

    Field Summary

    Field and Description -java.lang.String -city  +String +city +
    A string specifying the name of the city associated with the phone number.
    + PhoneIdLiveResponse.Location.Coordinates -coordinates  +coordinates +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    + PhoneIdLiveResponse.Location.Country -country  +country +
    An object containing details about the country associated with the phone number.
    + -java.lang.String -county  +String +county +
    A string specifying the name of the County (or Parish) associated with the phone number (U.S.
    + -java.lang.String -metro_code  +String +metro_code +
    A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S.
    + -java.lang.String -state  +String +state +
    The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    + PhoneIdLiveResponse.Location.TimeZone -time_zone  +time_zone +
    An object containing details about the Time Zone associated with the phone number.
    + -java.lang.String -zip  +String +zip +
    The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S.
    + @@ -206,11 +230,11 @@

    Constructor Summary

    Method Summary

    @@ -226,76 +250,84 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      county

      -
      public java.lang.String county
      +

      city

      +
      public String city
      +
      A string specifying the name of the city associated with the phone number.
    - +
    • -

      city

      -
      public java.lang.String city
      +

      coordinates

      +
      public PhoneIdLiveResponse.Location.Coordinates coordinates
      +
      An object containing details about the geographical coordinates of the location where the phone number is registered.
    - +
    • -

      state

      -
      public java.lang.String state
      +

      country

      +
      public PhoneIdLiveResponse.Location.Country country
      +
      An object containing details about the country associated with the phone number.
    - +
    • -

      zip

      -
      public java.lang.String zip
      +

      county

      +
      public String county
      +
      A string specifying the name of the County (or Parish) associated with the phone number (U.S. only).
    - +
    • -

      country

      -
      public PhoneIdLiveResponse.Location.Country country
      +

      metro_code

      +
      public String metro_code
      +
      A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau.
    - +
    • -

      time_zone

      -
      public PhoneIdLiveResponse.Location.TimeZone time_zone
      +

      state

      +
      public String state
      +
      The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    - + - +
    • -

      metro_code

      -
      public java.lang.String metro_code
      +

      zip

      +
      public String zip
      +
      The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only).
    @@ -334,10 +366,10 @@

    PhoneIdLiveResponse.Location

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -382,5 +414,6 @@

      PhoneIdLiveResponse.Location

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html index 6173700..63c4497 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Numbering.CleansingNumber.Number - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

        -
      • java.lang.Object
        • +
      • Object
        • com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
          • @@ -101,7 +101,8 @@

          PhoneIdLiveResponse.Numbering.CleansingNumber.Number -extends java.lang.Object +extends Object +
          An object containing cleansing details about a phone number.

    @@ -122,23 +123,33 @@

    Field Summary

    int -cleansed_code  +cleansed_code +
    One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
    + -java.lang.String -country_code  +String +country_code +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    + int -max_length  +max_length +
    The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    + int -min_length  +min_length +
    The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    + -java.lang.String -phone_number  +String +phone_number +
    The Base Phone Number.
    + @@ -167,11 +178,11 @@

    Constructor Summary

    Method Summary

    @@ -187,13 +198,14 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      cleansed_code

      +
      public int cleansed_code
      +
      One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number).
    @@ -202,34 +214,38 @@

    phone_number

     - +
    • -

      min_length

      -
      public int min_length
      +

      max_length

      +
      public int max_length
      +
      The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      max_length

      -
      public int max_length
      +

      min_length

      +
      public int min_length
      +
      The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      cleansed_code

      -
      public int cleansed_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -268,10 +284,10 @@

    PhoneIdLiveResponse.Numbering.CleansingNumber.Number

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -303,7 +319,7 @@

      PhoneIdLiveResponse.Numbering.CleansingNumber.Number

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -316,5 +332,6 @@

      PhoneIdLiveResponse.Numbering.CleansingNumber.Number

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html index 1bffbfe..4ca6e36 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Numbering.CleansingNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Cl

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
        • @@ -101,7 +101,8 @@

        Cl 

        public static class PhoneIdLiveResponse.Numbering.CleansingNumber
-extends java.lang.Object
        +extends Object +
        An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers.

    @@ -122,7 +123,9 @@

    Nested Class Summary

    static class  -PhoneIdLiveResponse.Numbering.CleansingNumber.Number  +PhoneIdLiveResponse.Numbering.CleansingNumber.Number +
    An object containing cleansing details about a phone number.
    + @@ -141,11 +144,15 @@

    Field Summary

    PhoneIdLiveResponse.Numbering.CleansingNumber.Number -call  +call +
    An object containing cleansing details about a phone number used for receiving voice calls.
    + PhoneIdLiveResponse.Numbering.CleansingNumber.Number -sms  +sms +
    An object containing cleansing details about a phone number used for receiving text messages.
    + @@ -174,11 +181,11 @@

    Constructor Summary

    Method Summary

    @@ -194,22 +201,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -248,10 +257,10 @@

    PhoneIdLiveResponse.Numbering.CleansingNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -296,5 +305,6 @@

      PhoneIdLiveResponse.Numbering.CleansingNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html index d3e0ffa..43f923a 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Numbering.OriginalNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Cla

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
        • @@ -101,7 +101,8 @@

        Cla 

        public static class PhoneIdLiveResponse.Numbering.OriginalNumber
-extends java.lang.Object
        +extends Object +
        An object containing details about the original phone number passed to TeleSign’s PhoneID API.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -complete_phone_number  +String +complete_phone_number +
    The Base Phone Number prefixed with the Country Dialing Code.
    + -java.lang.String -country_code  +String +country_code +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    + -java.lang.String -phone_number  +String +phone_number +
    The Base Phone Number.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      complete_phone_number

      +
      public String complete_phone_number
      +
      The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI.
    - +
    • -

      complete_phone_number

      -
      public java.lang.String complete_phone_number
      +

      country_code

      +
      public String country_code
      +
      A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44.
    - +
    • -

      country_code

      -
      public java.lang.String country_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -242,10 +252,10 @@

    PhoneIdLiveResponse.Numbering.OriginalNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -277,7 +287,7 @@

      PhoneIdLiveResponse.Numbering.OriginalNumber

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdLiveResponse.Numbering.OriginalNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html index 20005c6..76204c7 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Numbering - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdLiveR

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
        • @@ -101,7 +101,8 @@

        Class PhoneIdLiveR 

        public static class PhoneIdLiveResponse.Numbering
-extends java.lang.Object
        +extends Object +
        An object containing details about the numbering attributes of the specified phone number.

    @@ -122,11 +123,15 @@

    Nested Class Summary

    static class  -PhoneIdLiveResponse.Numbering.CleansingNumber  +PhoneIdLiveResponse.Numbering.CleansingNumber +
    An object containing details about how the phone number was cleansed.
    + static class  -PhoneIdLiveResponse.Numbering.OriginalNumber  +PhoneIdLiveResponse.Numbering.OriginalNumber +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -145,11 +150,15 @@

    Field Summary

    PhoneIdLiveResponse.Numbering.CleansingNumber -cleansing  +cleansing +
    An object containing details about how the phone number was cleansed.
    + PhoneIdLiveResponse.Numbering.OriginalNumber -original  +original +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -178,11 +187,11 @@

    Constructor Summary

    Method Summary

    @@ -198,22 +207,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -252,10 +263,10 @@

    PhoneIdLiveResponse.Numbering

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -300,5 +311,6 @@

      PhoneIdLiveResponse.Numbering

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html index 1c2fd83..87b9696 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.PhoneType - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdLiveR

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
        • @@ -101,7 +101,8 @@

        Class PhoneIdLiveR 

        public static class PhoneIdLiveResponse.PhoneType
-extends java.lang.Object
        +extends Object +
        An object containing details about the phone type.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    One of the Phone Type Codes."
    + -java.lang.String -description  +String +description +
    A description of the phone type.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    One of the Phone Type Codes."
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdLiveResponse.PhoneType

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdLiveResponse.PhoneType

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html index e95ebc9..bf3b603 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse.Status - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdLiveResp

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdLiveResponse.Status
        • @@ -101,7 +101,8 @@

        Class PhoneIdLiveResp 

        public static class PhoneIdLiveResponse.Status
-extends java.lang.Object
        +extends Object +
        An object containing details about the request status.

    @@ -122,15 +123,21 @@

    Field Summary

    int -code  +code +
    One of the Transaction Status Codes.
    + -java.lang.String -description  +String +description +
    A descriptionm of the transaction status.
    + -java.lang.String -updated_on  +String +updated_on +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      updated_on

      -
      public java.lang.String updated_on
      +

      code

      +
      public int code
      +
      One of the Transaction Status Codes.
    - +
    • -

      code

      -
      public int code
      +

      description

      +
      public String description
      +
      A descriptionm of the transaction status.
    - +
    • -

      description

      -
      public java.lang.String description
      +

      updated_on

      +
      public String updated_on
      +
      An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    @@ -242,10 +252,10 @@

    PhoneIdLiveResponse.Status

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdLiveResponse.Status

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.html b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.html index 9575ff8..9ad245e 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.html +++ b/doc/com/telesign/phoneid/response/PhoneIdLiveResponse.html @@ -2,9 +2,9 @@ - + PhoneIdLiveResponse - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    @@ -260,40 +288,45 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      reference_id

      -
      public java.lang.String reference_id
      +

      errors

      +
      public PhoneIdLiveResponse.Error[] errors
      +
      An array of PhoneIdLiveResponse.Error objects. Each Error object contains information about an error condition that might have resulted from the Request.
    - +
    • -

      resource_uri

      -
      public java.lang.String resource_uri
      +

      live

      +
      public PhoneIdLiveResponse.Live live
      +
      A JSON object containing details about a specified phone number’s state of operation. + Note: In the case where PhoneID Live is not supported for the specified phone number, the server returns a Live object that is null.
    - +
    • -

      sub_resource

      -
      public java.lang.String sub_resource
      +

      location

      +
      public PhoneIdLiveResponse.Location location
      +
      An object containing geographical location information associated with the phone number.
    - + @@ -303,51 +336,57 @@

    errors

  • phone_type

    public PhoneIdLiveResponse.PhoneType phone_type
    +
    An object that contains details about the phone type.
    • - +
    • -

      signature_string

      -
      public java.lang.String signature_string
      +

      reference_id

      +
      public String reference_id
      +
      A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    - + - +
    • -

      numbering

      -
      public PhoneIdLiveResponse.Numbering numbering
      +

      signature_string

      +
      public String signature_string
      +
      A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.
    - + - +
    • -

      live

      -
      public PhoneIdLiveResponse.Live live
      +

      sub_resource

      +
      public String sub_resource
      +
      A String containing the name of the subresource that was accessed. For example, "standard".
    @@ -381,11 +420,13 @@

    Method Detail

    • toString

      -
      public java.lang.String toString()
      +
      public String toString()
      +
      Converts a PhoneIdLiveResponse object to its equivalent JSON format, using the Gson class library.
      Overrides:
      -
      toString in class java.lang.Object
      -
      +
      toString in class Object
      +
      Returns:
      A string containing the response from the TeleSign server, in JSON format.
      See Also:
      Object.toString(), +Gson
    @@ -407,10 +448,10 @@

    toString

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -455,5 +496,6 @@

      toString

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html index 3933444..ddf47e6 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Error - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdScoreRes

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.Error
        • @@ -101,7 +101,8 @@

        Class PhoneIdScoreRes 

        public static class PhoneIdScoreResponse.Error
-extends java.lang.Object
        +extends Object +
        An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    + -java.lang.String -description  +String +description +
    A string that describes the type of error that occurred.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned.
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdScoreResponse.Error

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdScoreResponse.Error

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html index 1b66dd1..bab3ee1 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Numbering.CleansingNumber.Number - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

        -
      • java.lang.Object
        • +
      • Object
        • com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
          • @@ -101,7 +101,8 @@

          PhoneIdScoreResponse.Numbering.CleansingNumber.Number -extends java.lang.Object +extends Object +
          An object containing cleansing details about a phone number.

    @@ -122,23 +123,33 @@

    Field Summary

    int -cleansed_code  +cleansed_code +
    One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
    + -java.lang.String -country_code  +String +country_code +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    + int -max_length  +max_length +
    The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    + int -min_length  +min_length +
    The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    + -java.lang.String -phone_number  +String +phone_number +
    The Base Phone Number.
    + @@ -167,11 +178,11 @@

    Constructor Summary

    Method Summary

    @@ -187,13 +198,14 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      cleansed_code

      +
      public int cleansed_code
      +
      One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number).
    @@ -202,34 +214,38 @@

    phone_number

     - +
    • -

      min_length

      -
      public int min_length
      +

      max_length

      +
      public int max_length
      +
      The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      max_length

      -
      public int max_length
      +

      min_length

      +
      public int min_length
      +
      The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      cleansed_code

      -
      public int cleansed_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -268,10 +284,10 @@

    PhoneIdScoreResponse.Numbering.CleansingNumber.Number

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -303,7 +319,7 @@

      PhoneIdScoreResponse.Numbering.CleansingNumber.Number

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -316,5 +332,6 @@

      PhoneIdScoreResponse.Numbering.CleansingNumber.Number

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html index 732bf68..1592d60 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Numbering.CleansingNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      C

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
        • @@ -101,7 +101,8 @@

        C 

        public static class PhoneIdScoreResponse.Numbering.CleansingNumber
-extends java.lang.Object
        +extends Object +
        An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers.

    @@ -122,7 +123,9 @@

    Nested Class Summary

    static class  -PhoneIdScoreResponse.Numbering.CleansingNumber.Number  +PhoneIdScoreResponse.Numbering.CleansingNumber.Number +
    An object containing cleansing details about a phone number.
    + @@ -141,11 +144,15 @@

    Field Summary

    PhoneIdScoreResponse.Numbering.CleansingNumber.Number -call  +call +
    An object containing cleansing details about a phone number used for receiving voice calls.
    + PhoneIdScoreResponse.Numbering.CleansingNumber.Number -sms  +sms +
    An object containing cleansing details about a phone number used for receiving text messages.
    + @@ -174,11 +181,11 @@

    Constructor Summary

    Method Summary

    @@ -194,22 +201,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -248,10 +257,10 @@

    PhoneIdScoreResponse.Numbering.CleansingNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -296,5 +305,6 @@

      PhoneIdScoreResponse.Numbering.CleansingNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html index 7ae44a6..6c7d31b 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Numbering.OriginalNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Cl

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
        • @@ -101,7 +101,8 @@

        Cl 

        public static class PhoneIdScoreResponse.Numbering.OriginalNumber
-extends java.lang.Object
        +extends Object +
        An object containing details about the original phone number passed to TeleSign’s PhoneID API.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -complete_phone_number  +String +complete_phone_number +
    The Base Phone Number prefixed with the Country Dialing Code.
    + -java.lang.String -country_code  +String +country_code +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    + -java.lang.String -phone_number  +String +phone_number +
    The Base Phone Number.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      complete_phone_number

      +
      public String complete_phone_number
      +
      The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI.
    - +
    • -

      complete_phone_number

      -
      public java.lang.String complete_phone_number
      +

      country_code

      +
      public String country_code
      +
      A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44.
    - +
    • -

      country_code

      -
      public java.lang.String country_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -242,10 +252,10 @@

    PhoneIdScoreResponse.Numbering.OriginalNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -277,7 +287,7 @@

      PhoneIdScoreResponse.Numbering.OriginalNumber

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdScoreResponse.Numbering.OriginalNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html index 663e11e..1c17d4f 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Numbering - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdScor

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
        • @@ -101,7 +101,8 @@

        Class PhoneIdScor 

        public static class PhoneIdScoreResponse.Numbering
-extends java.lang.Object
        +extends Object +
        An object containing details about the numbering attributes of the specified phone number.

    @@ -122,11 +123,15 @@

    Nested Class Summary

    static class  -PhoneIdScoreResponse.Numbering.CleansingNumber  +PhoneIdScoreResponse.Numbering.CleansingNumber +
    An object containing details about how the phone number was cleansed.
    + static class  -PhoneIdScoreResponse.Numbering.OriginalNumber  +PhoneIdScoreResponse.Numbering.OriginalNumber +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -145,11 +150,15 @@

    Field Summary

    PhoneIdScoreResponse.Numbering.CleansingNumber -cleansing  +cleansing +
    An object containing details about how the phone number was cleansed.
    + PhoneIdScoreResponse.Numbering.OriginalNumber -original  +original +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -178,11 +187,11 @@

    Constructor Summary

    Method Summary

    @@ -198,22 +207,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -252,10 +263,10 @@

    PhoneIdScoreResponse.Numbering

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -300,5 +311,6 @@

      PhoneIdScoreResponse.Numbering

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html index e82ffc3..59cee85 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.PhoneType - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdScor

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
        • @@ -101,7 +101,8 @@

        Class PhoneIdScor 

        public static class PhoneIdScoreResponse.PhoneType
-extends java.lang.Object
        +extends Object +
        An object containing details about the phone type.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    One of the Phone Type Codes."
    + -java.lang.String -description  +String +description +
    A description of the phone type.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    One of the Phone Type Codes."
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdScoreResponse.PhoneType

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdScoreResponse.PhoneType

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html index 9b4d2ba..eb47c42 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Risk - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdScoreResp

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
        • @@ -101,7 +101,8 @@

        Class PhoneIdScoreResp 

        public static class PhoneIdScoreResponse.Risk
-extends java.lang.Object
        +extends Object +
        An object that describes the risk score for the phone number specified in the request.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -level  +String +level +
    A string indicating the severity of the risk.
    + -java.lang.String -recommendation  +String +recommendation +
    A string indicating the action that TeleSign recommends that you take based on the risk score.
    + int -score  +score +
    One of the Score values.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -185,25 +192,28 @@

    Field Detail

    • level

      -
      public java.lang.String level
      +
      public String level
      +
      A string indicating the severity of the risk.
    - +
    • -

      score

      -
      public int score
      +

      recommendation

      +
      public String recommendation
      +
      A string indicating the action that TeleSign recommends that you take based on the risk score.
    - +
    • -

      recommendation

      -
      public java.lang.String recommendation
      +

      score

      +
      public int score
      +
      One of the Score values.
    @@ -242,10 +252,10 @@

    PhoneIdScoreResponse.Risk

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdScoreResponse.Risk

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html index 3bb3297..c1e4c7e 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse.Status - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdScoreRe

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse.Status
        • @@ -101,7 +101,8 @@

        Class PhoneIdScoreRe 

        public static class PhoneIdScoreResponse.Status
-extends java.lang.Object
        +extends Object +
        An object containing details about the request status.

    @@ -122,15 +123,21 @@

    Field Summary

    int -code  +code +
    One of the Transaction Status Codes.
    + -java.lang.String -description  +String +description +
    A descriptionm of the transaction status.
    + -java.lang.String -updated_on  +String +updated_on +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      updated_on

      -
      public java.lang.String updated_on
      +

      code

      +
      public int code
      +
      One of the Transaction Status Codes.
    - +
    • -

      code

      -
      public int code
      +

      description

      +
      public String description
      +
      A descriptionm of the transaction status.
    - +
    • -

      description

      -
      public java.lang.String description
      +

      updated_on

      +
      public String updated_on
      +
      An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    @@ -242,10 +252,10 @@

    PhoneIdScoreResponse.Status

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdScoreResponse.Status

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.html b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.html index c8deff8..c6c8207 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.html +++ b/doc/com/telesign/phoneid/response/PhoneIdScoreResponse.html @@ -2,9 +2,9 @@ - + PhoneIdScoreResponse - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -84,7 +84,7 @@

      Class PhoneIdScoreResponse<

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdScoreResponse
        • @@ -97,14 +97,8 @@

        Class PhoneIdScoreResponse< 

        public class PhoneIdScoreResponse
-extends java.lang.Object
        -
        Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.score() request - - Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The PhoneIdScoreResponse class encapsulates all of the information returned from a call to the PhoneID Score web service.

    @@ -125,23 +119,33 @@

    Nested Class Summary

    static class  -PhoneIdScoreResponse.Error  +PhoneIdScoreResponse.Error +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    + static class  -PhoneIdScoreResponse.Numbering  +PhoneIdScoreResponse.Numbering +
    An object containing details about the numbering attributes of the specified phone number.
    + static class  -PhoneIdScoreResponse.PhoneType  +PhoneIdScoreResponse.PhoneType +
    An object containing details about the phone type.
    + static class  -PhoneIdScoreResponse.Risk  +PhoneIdScoreResponse.Risk +
    An object that describes the risk score for the phone number specified in the request.
    + static class  -PhoneIdScoreResponse.Status  +PhoneIdScoreResponse.Status +
    An object containing details about the request status.
    + @@ -160,35 +164,51 @@

    Field Summary

    PhoneIdScoreResponse.Error[] -errors  +errors +
    An array of PhoneIdScoreResponse.Error objects.
    + PhoneIdScoreResponse.Numbering -numbering  +numbering +
    An object containing details about the numbering attributes of the specified phone number.
    + -java.lang.String -reference_id  +String +reference_id +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    + -java.lang.String -resource_uri  +String +resource_uri +
    A String containing the URI for accesses the PhoneID resource.
    + PhoneIdScoreResponse.Risk -risk  +risk +
    An object that describes the risk score for the phone number specified in the request.
    + -java.lang.String -signature_string  +String +signature_string +
    A String containing the Signature, exactly as it was sent in the Request.
    + PhoneIdScoreResponse.Status -status  +status +
    An object containing details about the request status.
    + -java.lang.String -sub_resource  +String +sub_resource +
    A String containing the name of the subresource that was accessed.
    + @@ -223,16 +243,18 @@

    Method Summary

    Method and Description -java.lang.String -toString()  +String +toString() +
    Converts a PhoneIdScoreResponse object to its equivalent JSON format.
    + @@ -248,76 +270,84 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      reference_id

      -
      public java.lang.String reference_id
      +

      errors

      +
      public PhoneIdScoreResponse.Error[] errors
      +
      An array of PhoneIdScoreResponse.Error objects. Each Error object contains information about an error condition that might have resulted from the Request.
    - +
    • -

      resource_uri

      -
      public java.lang.String resource_uri
      +

      numbering

      +
      public PhoneIdScoreResponse.Numbering numbering
      +
      An object containing details about the numbering attributes of the specified phone number.
    - +
    • -

      sub_resource

      -
      public java.lang.String sub_resource
      +

      reference_id

      +
      public String reference_id
      +
      A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    - +
    • -

      errors

      -
      public PhoneIdScoreResponse.Error[] errors
      +

      resource_uri

      +
      public String resource_uri
      +
      A String containing the URI for accesses the PhoneID resource.
    - +
    • -

      signature_string

      -
      public java.lang.String signature_string
      +

      risk

      +
      public PhoneIdScoreResponse.Risk risk
      +
      An object that describes the risk score for the phone number specified in the request.
    - +
    • -

      status

      -
      public PhoneIdScoreResponse.Status status
      +

      signature_string

      +
      public String signature_string
      +
      A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.
    - + - +
    • -

      risk

      -
      public PhoneIdScoreResponse.Risk risk
      +

      sub_resource

      +
      public String sub_resource
      +
      A String containing the name of the subresource that was accessed. For example, "standard".
    @@ -351,11 +381,13 @@

    Method Detail

    • toString

      -
      public java.lang.String toString()
      +
      public String toString()
      +
      Converts a PhoneIdScoreResponse object to its equivalent JSON format.
      Overrides:
      -
      toString in class java.lang.Object
      -
      +
      toString in class Object
      +
      Returns:
      A string containing the response from the TeleSign server, in JSON format, using the Gson class library.
      See Also:
      Object.toString(), +Gson
    @@ -377,10 +409,10 @@

    toString

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -425,5 +457,6 @@

      toString

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html index b637c0a..d6f6bb0 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Error - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdStand

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Error
        • @@ -101,7 +101,8 @@

        Class PhoneIdStand 

        public static class PhoneIdStandardResponse.Error
-extends java.lang.Object
        +extends Object +
        An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    + -java.lang.String -description  +String +description +
    A string that describes the type of error that occurred.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned.
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdStandardResponse.Error

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdStandardResponse.Error

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html index acb4493..39f3ca3 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Location.Coordinates - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Cla

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
        • @@ -101,7 +101,8 @@

        Cla 

        public static class PhoneIdStandardResponse.Location.Coordinates
-extends java.lang.Object
        +extends Object +
        An object containing details about the geographical coordinates of the location where the phone number is registered.

    @@ -122,11 +123,15 @@

    Field Summary

    double -latitude  +latitude +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places.
    + double -longitude  +longitude +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • latitude

    public double latitude
    +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264.
    • @@ -191,6 +197,7 @@

    latitude

  • longitude

    public double longitude
    +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    • @@ -229,10 +236,10 @@

    PhoneIdStandardResponse.Location.Coordinates

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -264,7 +271,7 @@

      PhoneIdStandardResponse.Location.Coordinates

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdStandardResponse.Location.Coordinates

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html index 0b0de28..76065d0 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Location.Country - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class P

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
        • @@ -101,7 +101,8 @@

        Class P 

        public static class PhoneIdStandardResponse.Location.Country
-extends java.lang.Object
        +extends Object +
        An object containing details about the country associated with the phone number.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -iso2  +String +iso2 +
    The ISO 3166-1 2-letter Country Code associated with the phone number.
    + -java.lang.String -iso3  +String +iso3 +
    The ISO 3166-1 3-letter Country Code associated with the phone number
    + -java.lang.String -name  +String +name +
    The Country Name associated with phone number.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -185,7 +192,8 @@

    Field Detail

    • iso2

      -
      public java.lang.String iso2
      +
      public String iso2
      +
      The ISO 3166-1 2-letter Country Code associated with the phone number.
    @@ -194,7 +202,8 @@

    iso2

     @@ -203,7 +212,8 @@

    iso3

     @@ -242,10 +252,10 @@

    PhoneIdStandardResponse.Location.Country

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdStandardResponse.Location.Country

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html index c6f0174..8189cb4 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Location.TimeZone - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
        • @@ -101,7 +101,8 @@

        Class 

        public static class PhoneIdStandardResponse.Location.TimeZone
-extends java.lang.Object
        +extends Object +
        An object containing details about the Time Zone associated with the phone number.

    @@ -121,16 +122,22 @@

    Field Summary

    Field and Description -java.lang.String -name  +String +name +
    A string identifying the Time Zone Name (TZ) associated with the phone number (U.S.
    + -java.lang.String -utc_offset_max  +String +utc_offset_max +
    For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number.
    + -java.lang.String -utc_offset_min  +String +utc_offset_min +
    For U.S.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      utc_offset_min

      -
      public java.lang.String utc_offset_min
      +

      name

      +
      public String name
      +
      A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles".
    - +
    • -

      name

      -
      public java.lang.String name
      +

      utc_offset_max

      +
      public String utc_offset_max
      +
      For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min.
    - +
    • -

      utc_offset_max

      -
      public java.lang.String utc_offset_max
      +

      utc_offset_min

      +
      public String utc_offset_min
      +
      For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number.
    @@ -242,10 +252,10 @@

    PhoneIdStandardResponse.Location.TimeZone

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdStandardResponse.Location.TimeZone

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html index 9c366df..a392b0d 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Location - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdSt

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Location
        • @@ -101,7 +101,9 @@

        Class PhoneIdSt 

        public static class PhoneIdStandardResponse.Location
-extends java.lang.Object
        +extends Object +
        An object containing geographical location information associated with the phone number. + Note: Location refers to the place where the phone is registered, not to where it actually is at the time of this request.

    @@ -122,15 +124,21 @@

    Nested Class Summary

    static class  -PhoneIdStandardResponse.Location.Coordinates  +PhoneIdStandardResponse.Location.Coordinates +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    + static class  -PhoneIdStandardResponse.Location.Country  +PhoneIdStandardResponse.Location.Country +
    An object containing details about the country associated with the phone number.
    + static class  -PhoneIdStandardResponse.Location.TimeZone  +PhoneIdStandardResponse.Location.TimeZone +
    An object containing details about the Time Zone associated with the phone number.
    + @@ -148,36 +156,52 @@

    Field Summary

    Field and Description -java.lang.String -city  +String +city +
    A string specifying the name of the city associated with the phone number.
    + PhoneIdStandardResponse.Location.Coordinates -coordinates  +coordinates +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    + PhoneIdStandardResponse.Location.Country -country  +country +
    An object containing details about the country associated with the phone number.
    + -java.lang.String -county  +String +county +
    A string specifying the name of the County (or Parish) associated with the phone number (U.S.
    + -java.lang.String -metro_code  +String +metro_code +
    A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S.
    + -java.lang.String -state  +String +state +
    The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    + PhoneIdStandardResponse.Location.TimeZone -time_zone  +time_zone +
    An object containing details about the Time Zone associated with the phone number.
    + -java.lang.String -zip  +String +zip +
    The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S.
    + @@ -206,11 +230,11 @@

    Constructor Summary

    Method Summary

    @@ -226,76 +250,84 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      county

      -
      public java.lang.String county
      +

      city

      +
      public String city
      +
      A string specifying the name of the city associated with the phone number.
    - +
    • -

      city

      -
      public java.lang.String city
      +

      coordinates

      +
      public PhoneIdStandardResponse.Location.Coordinates coordinates
      +
      An object containing details about the geographical coordinates of the location where the phone number is registered.
    - + - +
    • -

      zip

      -
      public java.lang.String zip
      +

      county

      +
      public String county
      +
      A string specifying the name of the County (or Parish) associated with the phone number (U.S. only).
    - +
    • -

      country

      -
      public PhoneIdStandardResponse.Location.Country country
      +

      metro_code

      +
      public String metro_code
      +
      A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau.
    - + - + - +
    • -

      metro_code

      -
      public java.lang.String metro_code
      +

      zip

      +
      public String zip
      +
      The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only).
    @@ -334,10 +366,10 @@

    PhoneIdStandardResponse.Location

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -382,5 +414,6 @@

      PhoneIdStandardResponse.Location

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html index cda83cc..e28e5a9 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Numbering.CleansingNumber.Number - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

        -
      • java.lang.Object
        • +
      • Object
        • com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
          • @@ -101,7 +101,8 @@ 


          public static class PhoneIdStandardResponse.Numbering.CleansingNumber.Number
-extends java.lang.Object
          +extends Object +
          An object containing cleansing details about a phone number.

      @@ -122,23 +123,33 @@

      Field Summary

      int -cleansed_code  +cleansed_code +
      One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
      + -java.lang.String -country_code  +String +country_code +
      A 1, 2, or 3-digit number representing the Country Dialing Code.
      + int -max_length  +max_length +
      The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
      + int -min_length  +min_length +
      The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
      + -java.lang.String -phone_number  +String +phone_number +
      The Base Phone Number.
      + @@ -167,11 +178,11 @@

      Constructor Summary

      Method Summary

    @@ -187,13 +198,14 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      cleansed_code

      +
      public int cleansed_code
      +
      One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number).
    @@ -202,34 +214,38 @@

    phone_number

     - +
    • -

      min_length

      -
      public int min_length
      +

      max_length

      +
      public int max_length
      +
      The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      max_length

      -
      public int max_length
      +

      min_length

      +
      public int min_length
      +
      The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    - +
    • -

      cleansed_code

      -
      public int cleansed_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -268,10 +284,10 @@

    PhoneIdStandardResponse.Numbering.CleansingNumber.Number

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -303,7 +319,7 @@

      PhoneIdStandardResponse.Numbering.CleansingNumber.Number

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -316,5 +332,6 @@

      PhoneIdStandardResponse.Numbering.CleansingNumber.Number

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html index cb29198..c400af5 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Numbering.CleansingNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

        -
      • java.lang.Object
        • +
      • Object
        • com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
          • @@ -101,7 +101,8 @@

          PhoneIdStandardResponse.Numbering.CleansingNumber -extends java.lang.Object +extends Object +
          An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers.

    @@ -122,7 +123,9 @@

    Nested Class Summary

    static class  -PhoneIdStandardResponse.Numbering.CleansingNumber.Number  +PhoneIdStandardResponse.Numbering.CleansingNumber.Number +
    An object containing cleansing details about a phone number.
    + @@ -141,11 +144,15 @@

    Field Summary

    PhoneIdStandardResponse.Numbering.CleansingNumber.Number -call  +call +
    An object containing cleansing details about a phone number used for receiving voice calls.
    + PhoneIdStandardResponse.Numbering.CleansingNumber.Number -sms  +sms +
    An object containing cleansing details about a phone number used for receiving text messages.
    + @@ -174,11 +181,11 @@

    Constructor Summary

    Method Summary

    @@ -194,22 +201,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -248,10 +257,10 @@

    PhoneIdStandardResponse.Numbering.CleansingNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -296,5 +305,6 @@

      PhoneIdStandardResponse.Numbering.CleansingNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html index a0badf9..897ee10 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Numbering.OriginalNumber - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

        -
      • java.lang.Object
        • +
      • Object
        • com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
          • @@ -101,7 +101,8 @@ 


          public static class PhoneIdStandardResponse.Numbering.OriginalNumber
-extends java.lang.Object
          +extends Object +
          An object containing details about the original phone number passed to TeleSign’s PhoneID API.

      @@ -121,16 +122,22 @@

      Field Summary

      Field and Description -java.lang.String -complete_phone_number  +String +complete_phone_number +
      The Base Phone Number prefixed with the Country Dialing Code.
      + -java.lang.String -country_code  +String +country_code +
      A 1, 2, or 3-digit number representing the Country Dialing Code.
      + -java.lang.String -phone_number  +String +phone_number +
      The Base Phone Number.
      + @@ -159,11 +166,11 @@

      Constructor Summary

      Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      phone_number

      -
      public java.lang.String phone_number
      +

      complete_phone_number

      +
      public String complete_phone_number
      +
      The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI.
    - +
    • -

      complete_phone_number

      -
      public java.lang.String complete_phone_number
      +

      country_code

      +
      public String country_code
      +
      A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44.
    - +
    • -

      country_code

      -
      public java.lang.String country_code
      +

      phone_number

      +
      public String phone_number
      +
      The Base Phone Number. This is simply the phone number without the Country Dialing Code.
    @@ -242,10 +252,10 @@

    PhoneIdStandardResponse.Numbering.OriginalNumber

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -277,7 +287,7 @@

      PhoneIdStandardResponse.Numbering.OriginalNumber

    • Nested | 
    • Field | 
    • Constr | 
      • -
    • Method
      • +
    • Method
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdStandardResponse.Numbering.OriginalNumber

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html index 627db88..dad9c95 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Numbering - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdS

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
        • @@ -101,7 +101,8 @@

        Class PhoneIdS 

        public static class PhoneIdStandardResponse.Numbering
-extends java.lang.Object
        +extends Object +
        An object containing details about the numbering attributes of the specified phone number.

    @@ -122,11 +123,15 @@

    Nested Class Summary

    static class  -PhoneIdStandardResponse.Numbering.CleansingNumber  +PhoneIdStandardResponse.Numbering.CleansingNumber +
    An object containing details about how the phone number was cleansed.
    + static class  -PhoneIdStandardResponse.Numbering.OriginalNumber  +PhoneIdStandardResponse.Numbering.OriginalNumber +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -145,11 +150,15 @@

    Field Summary

    PhoneIdStandardResponse.Numbering.CleansingNumber -cleansing  +cleansing +
    An object containing details about how the phone number was cleansed.
    + PhoneIdStandardResponse.Numbering.OriginalNumber -original  +original +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    + @@ -178,11 +187,11 @@

    Constructor Summary

    Method Summary

    @@ -198,22 +207,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - + @@ -252,10 +263,10 @@

    PhoneIdStandardResponse.Numbering

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -300,5 +311,6 @@

      PhoneIdStandardResponse.Numbering

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html index 51d79db..282cb9b 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.PhoneType - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdS

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
        • @@ -101,7 +101,8 @@

        Class PhoneIdS 

        public static class PhoneIdStandardResponse.PhoneType
-extends java.lang.Object
        +extends Object +
        An object containing details about the phone type.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    One of the Phone Type Codes."
    + -java.lang.String -description  +String +description +
    A description of the phone type.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    One of the Phone Type Codes."
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    PhoneIdStandardResponse.PhoneType

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      PhoneIdStandardResponse.PhoneType

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html index 5ed3fdf..6eb35f2 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse.Status - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class PhoneIdStan

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse.Status
        • @@ -101,7 +101,8 @@

        Class PhoneIdStan 

        public static class PhoneIdStandardResponse.Status
-extends java.lang.Object
        +extends Object +
        An object containing details about the request status.

    @@ -122,15 +123,21 @@

    Field Summary

    int -code  +code +
    One of the Transaction Status Codes.
    + -java.lang.String -description  +String +description +
    A descriptionm of the transaction status.
    + -java.lang.String -updated_on  +String +updated_on +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      updated_on

      -
      public java.lang.String updated_on
      +

      code

      +
      public int code
      +
      One of the Transaction Status Codes.
    - +
    • -

      code

      -
      public int code
      +

      description

      +
      public String description
      +
      A descriptionm of the transaction status.
    - +
    • -

      description

      -
      public java.lang.String description
      +

      updated_on

      +
      public String updated_on
      +
      An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    @@ -242,10 +252,10 @@

    PhoneIdStandardResponse.Status

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      PhoneIdStandardResponse.Status

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.html b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.html index 936807c..73be382 100644 --- a/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.html +++ b/doc/com/telesign/phoneid/response/PhoneIdStandardResponse.html @@ -2,9 +2,9 @@ - + PhoneIdStandardResponse - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -84,7 +84,7 @@

      Class PhoneIdStandardRes

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.phoneid.response.PhoneIdStandardResponse
        • @@ -97,14 +97,8 @@

        Class PhoneIdStandardRes 

        public class PhoneIdStandardResponse
-extends java.lang.Object
        -
        Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.standard() request - - Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The PhoneIdStandardResponse class encapsulates all of the information returned from a call to the PhoneID Standard web service.

    @@ -125,23 +119,33 @@

    Nested Class Summary

    static class  -PhoneIdStandardResponse.Error  +PhoneIdStandardResponse.Error +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    + static class  -PhoneIdStandardResponse.Location  +PhoneIdStandardResponse.Location +
    An object containing geographical location information associated with the phone number.
    + static class  -PhoneIdStandardResponse.Numbering  +PhoneIdStandardResponse.Numbering +
    An object containing details about the numbering attributes of the specified phone number.
    + static class  -PhoneIdStandardResponse.PhoneType  +PhoneIdStandardResponse.PhoneType +
    An object containing details about the phone type.
    + static class  -PhoneIdStandardResponse.Status  +PhoneIdStandardResponse.Status +
    An object containing details about the request status.
    + @@ -160,39 +164,57 @@

    Field Summary

    PhoneIdStandardResponse.Error[] -errors  +errors +
    An array of PhoneIdStandardResponse.Error objects.
    + PhoneIdStandardResponse.Location -location  +location +
    An object containing geographical location information associated with the phone number.
    + PhoneIdStandardResponse.Numbering -numbering  +numbering +
    An object containing details about the numbering attributes of the specified phone number.
    + PhoneIdStandardResponse.PhoneType -phone_type  +phone_type +
    An object that contains details about the phone type.
    + -java.lang.String -reference_id  +String +reference_id +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    + -java.lang.String -resource_uri  +String +resource_uri +
    A String containing the URI for accesses the PhoneID resource.
    + -java.lang.String -signature_string  +String +signature_string +
    A String containing the Signature, exactly as it was sent in the Request.
    + PhoneIdStandardResponse.Status -status  +status +
    An object containing details about the request status.
    + -java.lang.String -sub_resource  +String +sub_resource +
    A String containing the name of the subresource that was accessed.
    + @@ -227,16 +249,18 @@

    Method Summary

    Method and Description -java.lang.String -toString()  +String +toString() +
    Converts a PhoneIdStandardResponse object to its equivalent JSON format, using the Gson class library.
    + @@ -252,85 +276,94 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - + - +
    • -

      resource_uri

      -
      public java.lang.String resource_uri
      +

      location

      +
      public PhoneIdStandardResponse.Location location
      +
      An object containing geographical location information associated with the phone number.
    - +
    • -

      sub_resource

      -
      public java.lang.String sub_resource
      +

      numbering

      +
      public PhoneIdStandardResponse.Numbering numbering
      +
      An object containing details about the numbering attributes of the specified phone number.
    - + - +
    • -

      phone_type

      -
      public PhoneIdStandardResponse.PhoneType phone_type
      +

      reference_id

      +
      public String reference_id
      +
      A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    - +
    • -

      signature_string

      -
      public java.lang.String signature_string
      +

      resource_uri

      +
      public String resource_uri
      +
      A String containing the URI for accesses the PhoneID resource.
    - +
    • -

      status

      -
      public PhoneIdStandardResponse.Status status
      +

      signature_string

      +
      public String signature_string
      +
      A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.
    - + - +
    • -

      location

      -
      public PhoneIdStandardResponse.Location location
      +

      sub_resource

      +
      public String sub_resource
      +
      A String containing the name of the subresource that was accessed. For example, "standard".
    @@ -364,11 +397,13 @@

    Method Detail

    • toString

      -
      public java.lang.String toString()
      +
      public String toString()
      +
      Converts a PhoneIdStandardResponse object to its equivalent JSON format, using the Gson class library.
      Overrides:
      -
      toString in class java.lang.Object
      -
      +
      toString in class Object
      +
      Returns:
      A string containing the response from the TeleSign server, in JSON format.
      See Also:
      Object.toString(), +Gson
    @@ -390,10 +425,10 @@

    toString

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -438,5 +473,6 @@

      toString

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/class-use/PhoneIdContactResponse.Contact.html b/doc/com/telesign/phoneid/response/class-use/PhoneIdContactResponse.Contact.html index 8d137b3..dfab526 100644 --- a/doc/com/telesign/phoneid/response/class-use/PhoneIdContactResponse.Contact.html +++ b/doc/com/telesign/phoneid/response/class-use/PhoneIdContactResponse.Contact.html @@ -2,9 +2,9 @@ - + Uses of Class com.telesign.phoneid.response.PhoneIdContactResponse.Contact - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
      @@ -77,7 +77,10 @@

      com.telesign.phoneid -  + +
      + Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service.
      + @@ -97,9 +100,9 @@

      Uses of PhoneIdContactResponse -PhoneId.contact(java.lang.String identifier, - java.lang.String ucid) -
      Make a phoneid contact request to TeleSign's public API.
      +PhoneId.contact(String identifier, + String ucid) +
      Returns contact details for a specified phone number’s subscriber.
      @@ -121,10 +124,10 @@

      Uses of Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help

    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
      @@ -77,7 +77,10 @@

      com.telesign.phoneid -  + +
      + Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service.
      + @@ -97,9 +100,9 @@

      Uses of PhoneIdLiveResponse -PhoneId.live(java.lang.String identifier, - java.lang.String ucid) -
      Make a phoneid live request to TeleSign's public API.
      +PhoneId.live(String identifier, + String ucid) +
      Returns information about a specified phone number’s state of operation.
      @@ -121,10 +124,10 @@

      Uses of Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help

    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/com/telesign/phoneid/response/class-use/PhoneIdScoreResponse.Risk.html b/doc/com/telesign/phoneid/response/class-use/PhoneIdScoreResponse.Risk.html index b71f957..bf2aebf 100644 --- a/doc/com/telesign/phoneid/response/class-use/PhoneIdScoreResponse.Risk.html +++ b/doc/com/telesign/phoneid/response/class-use/PhoneIdScoreResponse.Risk.html @@ -2,9 +2,9 @@ - + Uses of Class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help

    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
      @@ -77,7 +77,10 @@

      com.telesign.phoneid -  + +
      + Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service.
      + @@ -97,9 +100,9 @@

      Uses of PhoneIdScoreResponse -PhoneId.score(java.lang.String identifier, - java.lang.String ucid) -
      Make a phoneid score request to TeleSign's public API.
      +PhoneId.score(String identifier, + String ucid) +
      Returns risk information about a specified phone number, including a real-time risk score, threat level, and recommendation for action.
      @@ -121,10 +124,10 @@

      Uses of Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help

    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
      @@ -77,7 +77,10 @@

      com.telesign.phoneid -  + +
      + Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service.
      + @@ -97,8 +100,8 @@

      Uses of PhoneIdStandardResponse -PhoneId.standard(java.lang.String identifier) -
      Make a phoneid standard request to Telesign's public API.
      +PhoneId.standard(String identifier) +
      Returns information about a specified phone number’s type, numbering structure, cleansing details, and location details.
      @@ -120,10 +123,10 @@

      Uses of Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help

    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -333,5 +419,6 @@

      Package com.telesign.phoneid.response

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/phoneid/response/package-tree.html b/doc/com/telesign/phoneid/response/package-tree.html index f20f5fc..1ed30c8 100644 --- a/doc/com/telesign/phoneid/response/package-tree.html +++ b/doc/com/telesign/phoneid/response/package-tree.html @@ -2,9 +2,9 @@ - + com.telesign.phoneid.response Class Hierarchy - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -72,7 +72,7 @@

      Hierarchy For Package com.telesign.phoneid.response

      Class Hierarchy

        @@ -170,5 +170,6 @@

        Class Hierarchy

      +

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/com/telesign/phoneid/response/package-use.html b/doc/com/telesign/phoneid/response/package-use.html index 22981e2..1d9c6a4 100644 --- a/doc/com/telesign/phoneid/response/package-use.html +++ b/doc/com/telesign/phoneid/response/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package com.telesign.phoneid.response - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -315,5 +393,6 @@

      Uses of

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/response/ResponseTest.html b/doc/com/telesign/response/ResponseTest.html new file mode 100644 index 0000000..1d2ab91 --- /dev/null +++ b/doc/com/telesign/response/ResponseTest.html @@ -0,0 +1,286 @@ + + + + + +ResponseTest + + + + + + + +
    + + + + + +
    +
    +
      +
    • Prev Class
      • +
    • Next Class
      • +
    + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + +
    +
    com.telesign.response
    +

    Class ResponseTest

    +
    +
    +
      +
    • java.lang.Object
      • +
    • +
        +
      • com.telesign.response.ResponseTest
        • +
      +
      • +
    +
    +
      +
    • +
      +
      +
      public class ResponseTest
+extends java.lang.Object
      +
      Copyright (c) TeleSign Corporation 2012. + License: MIT + Support email address "support@telesign.com" + Author: jweatherford
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Summary

        + + + + + + + + +
        Constructors 
        Constructor and Description
        ResponseTest() 
        +
        • +
      + +
        +
      • + + +

        Method Summary

        + + + + + + + + + + + + + + + + + + +
        Methods 
        Modifier and TypeMethod and Description
        voidGsonEnabled() 
        voidInvalidResponse() 
        voidValidResponse() 
        +
          +
        • + + +

          Methods inherited from class java.lang.Object

          +equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
          • +
        +
        • +
      +
      • +
    +
    +
    +
      +
    • + +
        +
      • + + +

        Constructor Detail

        + + + +
          +
        • +

          ResponseTest

          +
          public ResponseTest()
          +
          • +
        +
        • +
      + +
        +
      • + + +

        Method Detail

        + + + +
          +
        • +

          GsonEnabled

          +
          public void GsonEnabled()
          +
          • +
        + + + +
          +
        • +

          ValidResponse

          +
          public void ValidResponse()
          +
          • +
        + + + +
          +
        • +

          InvalidResponse

          +
          public void InvalidResponse()
          +
          • +
        +
        • +
      +
      • +
    +
    +
    + + +
    + + + + + +
    +
    +
      +
    • Prev Class
      • +
    • Next Class
      • +
    + + +
    + +
    +
    +
      +
    • Summary: 
      • +
    • Nested | 
      • +
    • Field | 
      • +
    • Constr | 
      • +
    • Method
      • +
    + +
    + + +
    + + + diff --git a/doc/com/telesign/response/class-use/ResponseTest.html b/doc/com/telesign/response/class-use/ResponseTest.html new file mode 100644 index 0000000..875b411 --- /dev/null +++ b/doc/com/telesign/response/class-use/ResponseTest.html @@ -0,0 +1,115 @@ + + + + + +Uses of Class com.telesign.response.ResponseTest + + + + + + + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Uses of Class
    com.telesign.response.ResponseTest

    +
    +
    No usage of com.telesign.response.ResponseTest
    + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/doc/com/telesign/response/package-frame.html b/doc/com/telesign/response/package-frame.html new file mode 100644 index 0000000..14958a3 --- /dev/null +++ b/doc/com/telesign/response/package-frame.html @@ -0,0 +1,19 @@ + + + + + +com.telesign.response + + + + +

    com.telesign.response

    +
    +

    Classes

    + +
    + + diff --git a/doc/com/telesign/response/package-summary.html b/doc/com/telesign/response/package-summary.html new file mode 100644 index 0000000..9d9a596 --- /dev/null +++ b/doc/com/telesign/response/package-summary.html @@ -0,0 +1,135 @@ + + + + + +com.telesign.response + + + + + + + +
    + + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Package com.telesign.response

    +
    +
    +
      +
    • + + + + + + + + + + + + +
      Class Summary 
      ClassDescription
      ResponseTest +
      Copyright (c) TeleSign Corporation 2012.
      +
      +
      • +
    +
    + +
    + + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/doc/com/telesign/response/package-tree.html b/doc/com/telesign/response/package-tree.html new file mode 100644 index 0000000..9d337b1 --- /dev/null +++ b/doc/com/telesign/response/package-tree.html @@ -0,0 +1,128 @@ + + + + + +com.telesign.response Class Hierarchy + + + + + + + +
    + + + + + +
    +
    + + + +
    + +
    + + +
    + +
    +

    Hierarchy For Package com.telesign.response

    +Package Hierarchies: + +
    +
    +

    Class Hierarchy

    +
      +
    • java.lang.Object + +
      • +
    +
    + +
    + + + + + +
    +
    + + + +
    + +
    + + +
    + + + diff --git a/doc/com/telesign/response/package-use.html b/doc/com/telesign/response/package-use.html new file mode 100644 index 0000000..b1fe710 --- /dev/null +++ b/doc/com/telesign/response/package-use.html @@ -0,0 +1,115 @@ + + + + + +Uses of Package com.telesign.response + + + + + + + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + +
    +

    Uses of Package
    com.telesign.response

    +
    +
    No usage of com.telesign.response
    + +
    + + + + + +
    +
    +
      +
    • Prev
      • +
    • Next
      • +
    + + +
    + +
    + + +
    + + + diff --git a/doc/com/telesign/util/PhoneUtil.html b/doc/com/telesign/util/PhoneUtil.html index 2a75568..b048987 100644 --- a/doc/com/telesign/util/PhoneUtil.html +++ b/doc/com/telesign/util/PhoneUtil.html @@ -2,9 +2,9 @@ - + PhoneUtil - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -84,7 +84,7 @@

      Class PhoneUtil

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.util.PhoneUtil
        • @@ -97,11 +97,8 @@

        Class PhoneUtil


        public class PhoneUtil
-extends java.lang.Object
        -
        Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The PhoneUtil class contains a mentod for normalizing phone numbers.
    @@ -138,18 +135,18 @@

    Method Summary

    Method and Description -static java.lang.String -formatTo11Digits(java.lang.String phoneNumber) -
    helper method to validate numbers to 11 digits
    +static String +formatTo11Digits(String phoneNumber) +
    This mentod is a helper method for cleansing phone numbers.
    @@ -188,10 +185,12 @@

    Method Detail

    • formatTo11Digits

      -
      public static java.lang.String formatTo11Digits(java.lang.String phoneNumber)
      -
      helper method to validate numbers to 11 digits
      -
      Parameters:
      phoneNumber -
      -
      Returns:
      the phone number validated to 11 digits
      +
      public static String formatTo11Digits(String phoneNumber)
      +
      This mentod is a helper method for cleansing phone numbers. + Specifically, it ensures that all phone number conform to a standard 11 digit format. + For example, (310) 555-1212 becomes 13105551212.
      +
      Parameters:
      phoneNumber - [Required] A string that contains the user's phone number, in its original form.
      +
      Returns:
      The cleansed form of the phone number.
    @@ -213,10 +212,10 @@

    formatTo11Digits

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -261,5 +260,6 @@

      formatTo11Digits

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/util/TeleSignRequest.html b/doc/com/telesign/util/TeleSignRequest.html index a446ec9..0060212 100644 --- a/doc/com/telesign/util/TeleSignRequest.html +++ b/doc/com/telesign/util/TeleSignRequest.html @@ -2,9 +2,9 @@ - + TeleSignRequest - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,13 +62,13 @@ @@ -84,7 +84,7 @@

      Class TeleSignRequest

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.util.TeleSignRequest
        • @@ -97,17 +97,104 @@

        Class TeleSignRequest


        public class TeleSignRequest
-extends java.lang.Object
        -
        Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The TeleSignRequest class is an abstraction for creating and sending HTTP 1.1 + REST Requests for TeleSign web services.
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Uses of Clas

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/util/class-use/TeleSignRequest.html b/doc/com/telesign/util/class-use/TeleSignRequest.html index b064c4b..178bd37 100644 --- a/doc/com/telesign/util/class-use/TeleSignRequest.html +++ b/doc/com/telesign/util/class-use/TeleSignRequest.html @@ -2,9 +2,9 @@ - + Uses of Class com.telesign.util.TeleSignRequest - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Uses o

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/util/package-frame.html b/doc/com/telesign/util/package-frame.html index 923afb7..b2b3bbc 100644 --- a/doc/com/telesign/util/package-frame.html +++ b/doc/com/telesign/util/package-frame.html @@ -2,9 +2,9 @@ - + com.telesign.util - + diff --git a/doc/com/telesign/util/package-summary.html b/doc/com/telesign/util/package-summary.html index 4771ae5..69d6943 100644 --- a/doc/com/telesign/util/package-summary.html +++ b/doc/com/telesign/util/package-summary.html @@ -2,9 +2,9 @@ - + com.telesign.util - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -64,6 +64,11 @@

      Package com.telesign.util

      +
      +
      + Contains a class for normalizing a phone number, and a class that represents a TeleSign service request object.
      +
      +

      See: Description

        @@ -78,19 +83,27 @@

        Package com.telesign.util

        PhoneUtil -
        Copyright (c) TeleSign Corporation 2012.
        +
        The PhoneUtil class contains a mentod for normalizing phone numbers.
        TeleSignRequest -
        Copyright (c) TeleSign Corporation 2012.
        +
        The TeleSignRequest class is an abstraction for creating and sending HTTP 1.1 + REST Requests for TeleSign web services.
      + + + +

      Package com.telesign.util Description

      +

      + Contains a class for normalizing a phone number, and a class that represents a TeleSign service request object. +

      @@ -104,10 +117,10 @@

      Package com.telesign.util

    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    DocBuild:
      @@ -137,5 +150,6 @@

      Package com.telesign.util

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/util/package-tree.html b/doc/com/telesign/util/package-tree.html index ab4ab1c..8297983 100644 --- a/doc/com/telesign/util/package-tree.html +++ b/doc/com/telesign/util/package-tree.html @@ -2,9 +2,9 @@ - + com.telesign.util Class Hierarchy - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -72,7 +72,7 @@

      Hierarchy For Package com.telesign.util

      Class Hierarchy

        @@ -125,5 +125,6 @@

        Class Hierarchy

      +

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/com/telesign/util/package-use.html b/doc/com/telesign/util/package-use.html index 9e2a721..b9cc5ce 100644 --- a/doc/com/telesign/util/package-use.html +++ b/doc/com/telesign/util/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package com.telesign.util - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Uses of Package
      c

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/Verify.html b/doc/com/telesign/verify/Verify.html index b4fba3c..e722201 100644 --- a/doc/com/telesign/verify/Verify.html +++ b/doc/com/telesign/verify/Verify.html @@ -2,9 +2,9 @@ - + Verify - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,13 +62,13 @@ @@ -84,7 +84,7 @@

      Class Verify

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.verify.Verify
        • @@ -97,17 +97,38 @@

        Class Verify


        public class Verify
-extends java.lang.Object
        -
        Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The Verify class abstracts your interactions with the TeleSign Verify web service. + A Verify object encapsulates your credentials (your TeleSign Customer ID and Secret Key).
    • + + @@ -209,6 +230,32 @@

      Methods inherited from class java.lang.Object

      • + +
          +
        • + + +

          Field Detail

          + + + +
            +
          • +

            customer_id

            +
            private final String customer_id
            +
            • +
          + + + +
            +
          • +

            secret_key

            +
            private final String secret_key
            +
            • +
          +
          • +
        • @@ -221,16 +268,11 @@

          Constructor Detail
          • @@ -241,103 +283,93 @@

          Verify

          Method Detail

          - +
          • -

            sms

            -
            public VerifyResponse sms(java.lang.String identifier)
            -
            Convenience method an overload of sms(String, String, String, String)
            -
            Parameters:
            identifier - the phone number to send the sms message
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +

            call

            +
            public VerifyResponse call(String phone_number)
            +
            Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code. + This is the simplest of the three overloads of this method. This overload takes the only required paramter—the end user's phone number.
            +
            Parameters:
            phone_number - [Required] A string representing the user’s phone number.
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          - +
          • -

            sms

            -
            public VerifyResponse sms(java.lang.String identifier,
-                 java.lang.String language)
            -
            Convenience method an overload of sms(String, String, String, String)
            -
            Parameters:
            identifier - the phone number to send the sms message
            language - The String representation of the language to send the sms message
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +

            call

            +
            public VerifyResponse call(String phone_number,
+                  String language)
            +
            Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code. + Use this overload when the end user's spoken language isn't the default language (English).
            +
            Parameters:
            phone_number - [Required] A string representing the user’s phone number.
            language - [Required] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          - +
          • -

            sms

            -
            public VerifyResponse sms(java.lang.String identifier,
-                 java.lang.String language,
-                 java.lang.String verify_code,
-                 java.lang.String template)
            -
            Make a Verify SMS request to TeleSign's API. This method allows - the language, verification code and template of the message to be set. - -

            - https://portal.telesign.com/docs/content/verify-sms.html

            -
            Parameters:
            identifier - the phone number to send the sms message
            language - The String representation of the language to send the sms message
            verify_code - The code to send via sms. Set to null to let Telesign generate the code
            template - The template of the message that is being sent. Set to null for default, otherwise must include $$CODE$$ as a variable placeholder
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +

            call

            +
            public VerifyResponse call(String phone_number,
+                  String language,
+                  String verify_code,
+                  String verify_method,
+                  int extension_type,
+                  String extension_template,
+                  boolean redial)
            +
            Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code. + Use this overload when the end user's written language isn't the default language (English), or when you want to send them a verification code that you create, or when you need to specify a method for handling automated interactions with a PBX .
            +
            Parameters:
            phone_number - [Required] A string representing the user’s phone number.
            language - [Required] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
            verify_code - [Optional] A string representing the verification code that you want to send to the end user. TeleSign will automatically generate a verification code for you if to set this value to null.
            verify_method - [Optional] A string representing the input method you want the end user to use when returning the verification code. Use a value of "keypress" when you want the user to use their phone to dial the code. Set this value to null when you want the user to enter the code into your web aplication (the default).
            extension_type - [Optional] An Integer value representing the type of response to use when dialing into a Private Branch Exchange (PBX). Use a value of 1 to have TeleSign use Dual-Tone Multi-Frequency (DTMF) tones to dail the user's extension. Use a value of 2 to have TeleSign use voice automation to request the user's extension. Use a value of 0 (the default) when the user isn't behind a PBX.
            extension_template - [Optional] A numerical string specifying the user's PBX extension number. Since this value is used in the callstring, you can include one second pauses by adding commas before the extension number. Set this value to null (the default) if not used.
            redial - [Optional] A boolean value that enables/disables redialing. Set this value to "true" (the default) when you want TeleSign to reattempt the call after a failed attempt. Set this value to "false" when you don't.
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          - +
          • -

            call

            -
            public VerifyResponse call(java.lang.String identifier)
            -
            Convenience method for call(String, String, String, String, int, String, boolean)
            -
            Parameters:
            identifier - Required, the phone number of the person to dial
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +

            sms

            +
            public VerifyResponse sms(String identifier)
            +
            Delivers a verification code to the end user by sending it in a text message. + This is the simplest of the three overloads of this method. This overload takes the only required paramter—the end user's phone number.
            +
            Parameters:
            identifier - [Required] A string representing the user’s phone number.
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          - +
          • -

            call

            -
            public VerifyResponse call(java.lang.String identifier,
-                  java.lang.String language)
            -
            Convenience method for call(String, String, String, String, int, String, boolean)
            -
            Parameters:
            identifier - Required, th phone number of the person to dial
            language - optional can be null. The language code of the call
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +

            sms

            +
            public VerifyResponse sms(String identifier,
+                 String language)
            +
            Delivers a verification code to the end user by sending it in a text message. + Use this overload when the end user's written language isn't the default language (English).
            +
            Parameters:
            identifier - [Required] A string representing the user’s phone number.
            language - [Optional] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          - +
          • -

            call

            -
            public VerifyResponse call(java.lang.String identifier,
-                  java.lang.String language,
-                  java.lang.String verify_code,
-                  java.lang.String verify_method,
-                  int extension_type,
-                  java.lang.String extension_template,
-                  boolean redial)
            -
            Make a Verify API call to TeleSigns phone service. Calling this method - results in an automated phone call made to the given identifier. The language - is specified as a string. Extensions and delays are programmable using the - extension_type and extension template. - -

            - https://portal.telesign.com/docs/content/verify-call.html

            -
            Parameters:
            identifier - Required, the phone number of the person to dial
            language - optional can be null. The language code of the call
            verify_code - optional. if null, verify code will be generated by telesign
            verify_method - optional. Only available option is currently null (dictated code) or "keypress"
            extension_type - optional. If 0, no extension. if 1, DTMF extension. If 2, voice extension
            extension_template - optional. If null not used. Otherwise the extension to reach
            redial - optional. Default true
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +

            sms

            +
            public VerifyResponse sms(String identifier,
+                 String language,
+                 String verify_code,
+                 String template)
            +
            Delivers a verification code to the end user by sending it in a text message. + Use this overload when the end user's written language isn't the default language (English), or when you want to send them a verification code that you create, or when you want to apply a custom text message template.
            +
            Parameters:
            identifier - [Required] A string representing the user’s phone number.
            language - [Optional] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
            verify_code - [Optional] A string representing the verification code that you want to send to the end user. TeleSign will automatically generate a verification code for you if to set this value to null.
            template - [Optional] A string representing a text message to override the predefined text message template. Your text message must incorporate a $$CODE$$ placeholder to integrate the verify_code field. Set this value to null (the default) to use the predefined template.
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          @@ -346,13 +378,12 @@

          call

          • status

            -
            public VerifyResponse status(java.lang.String resource_id)
            -
            Return the results of the post referenced by the reference_id. After a verify - SMS or Call has been made, the status of that verification request can be retrieved - with this method.
            -
            Parameters:
            resource_id - the id returned from either requestsSMS or requestCall
            -
            Returns:
            VerifyResponse The fully formed - response object repersentation of the JSON reply
            +
            public VerifyResponse status(String resource_id)
            +
            Retrieves the status of a phone verification (for either SMS or Call). + Call this method as a follow-up, after sending a verification code to an end user. + This method takes only one paramter—the reference identifier that you received from TeleSign after calling either com.telesign.verify or com.telesign.verify.
            +
            Parameters:
            resource_id - [Required] The string value that uniquely identifies a Phone Verify service transaction. Each time you make a Phone Verify call, the TeleSign server responds with this auto-generated value.
            +
            Returns:
            A VerifyResponse object, which contains the JSON-formatted response body from the TeleSign server.
          @@ -374,10 +405,10 @@

          status

        • Class
        • Use
        • Tree
          • -
        • Deprecated
        • Index
        • Help
        +
        DocBuild:
        @@ -407,13 +438,13 @@

        status

        @@ -422,5 +453,6 @@

        status

      +

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/com/telesign/verify/class-use/Verify.html b/doc/com/telesign/verify/class-use/Verify.html index b6e0a6f..769838d 100644 --- a/doc/com/telesign/verify/class-use/Verify.html +++ b/doc/com/telesign/verify/class-use/Verify.html @@ -2,9 +2,9 @@ - + Uses of Class com.telesign.verify.Verify - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Uses of Class

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/package-frame.html b/doc/com/telesign/verify/package-frame.html index d97fff6..aa68968 100644 --- a/doc/com/telesign/verify/package-frame.html +++ b/doc/com/telesign/verify/package-frame.html @@ -2,9 +2,9 @@ - + com.telesign.verify - + diff --git a/doc/com/telesign/verify/package-summary.html b/doc/com/telesign/verify/package-summary.html index bdc7b35..1bd8107 100644 --- a/doc/com/telesign/verify/package-summary.html +++ b/doc/com/telesign/verify/package-summary.html @@ -2,9 +2,9 @@ - + com.telesign.verify - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -64,6 +64,11 @@

      Package com.telesign.verify

      +
      +
      + Contains the Verify class, which abstracts calls to the TeleSign Verify Web Service.
      +
      +

      See: Description

        @@ -78,13 +83,25 @@

        Package com.telesign.verify

        Verify -
        Copyright (c) TeleSign Corporation 2012.
        +
        The Verify class abstracts your interactions with the TeleSign Verify web service.
      + + + +

      Package com.telesign.verify Description

      +

      + Contains the Verify class, which abstracts calls to the TeleSign Verify Web Service. +

      +

      + The Phone Verify web service provides an identity verification solution that uses the telephone to deliver a one-time validation code to your end users. + Upon receiving this code, your users just type it into their computer and send it back to you (or to us if they dial it into their phone). + The validity of their identity is then determined by simply comparing the codes they return to the ones we send them—and a match is considered positive identification. +

      @@ -98,10 +115,10 @@

      Package com.telesign.verify

    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    DocBuild:
      @@ -131,5 +148,6 @@

      Package com.telesign.verify

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/package-tree.html b/doc/com/telesign/verify/package-tree.html index e05db92..f80a6b1 100644 --- a/doc/com/telesign/verify/package-tree.html +++ b/doc/com/telesign/verify/package-tree.html @@ -2,9 +2,9 @@ - + com.telesign.verify Class Hierarchy - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -72,7 +72,7 @@

      Hierarchy For Package com.telesign.verify

      Class Hierarchy

      +
      DocBuild:
        @@ -124,5 +124,6 @@

        Class Hierarchy

      +

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/com/telesign/verify/package-use.html b/doc/com/telesign/verify/package-use.html index 3cf6d01..7fb7c8a 100644 --- a/doc/com/telesign/verify/package-use.html +++ b/doc/com/telesign/verify/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package com.telesign.verify - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Uses of Package

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/response/VerifyResponse.Error.html b/doc/com/telesign/verify/response/VerifyResponse.Error.html index 96c424b..8e28abc 100644 --- a/doc/com/telesign/verify/response/VerifyResponse.Error.html +++ b/doc/com/telesign/verify/response/VerifyResponse.Error.html @@ -2,9 +2,9 @@ - + VerifyResponse.Error - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class VerifyResponse.Error<

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.verify.response.VerifyResponse.Error
        • @@ -101,7 +101,8 @@

        Class VerifyResponse.Error< 

        public static class VerifyResponse.Error
-extends java.lang.Object
        +extends Object +
        An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.

    @@ -122,11 +123,15 @@

    Field Summary

    int -code  +code +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    + -java.lang.String -description  +String +description +
    A string that describes the type of error that occurred.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -182,6 +187,7 @@

    Field Detail

  • code

    public int code
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned.
    • @@ -190,7 +196,8 @@

    code

     @@ -229,10 +236,10 @@

    VerifyResponse.Error

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      VerifyResponse.Error

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/response/VerifyResponse.Status.html b/doc/com/telesign/verify/response/VerifyResponse.Status.html index 5ce6c5b..088be9f 100644 --- a/doc/com/telesign/verify/response/VerifyResponse.Status.html +++ b/doc/com/telesign/verify/response/VerifyResponse.Status.html @@ -2,9 +2,9 @@ - + VerifyResponse.Status - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class VerifyResponse.Statu

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.verify.response.VerifyResponse.Status
        • @@ -101,7 +101,8 @@

        Class VerifyResponse.Statu 

        public static class VerifyResponse.Status
-extends java.lang.Object
        +extends Object +
        An object containing details about the request status.

    @@ -122,15 +123,21 @@

    Field Summary

    int -code  +code +
    One of the Transaction Status Codes.
    + -java.lang.String -description  +String +description +
    A descriptionm of the transaction status.
    + -java.lang.String -updated_on  +String +updated_on +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    + @@ -159,11 +166,11 @@

    Constructor Summary

    Method Summary

    @@ -179,31 +186,34 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      updated_on

      -
      public java.lang.String updated_on
      +

      code

      +
      public int code
      +
      One of the Transaction Status Codes.
    - +
    • -

      code

      -
      public int code
      +

      description

      +
      public String description
      +
      A descriptionm of the transaction status.
    - +
    • -

      description

      -
      public java.lang.String description
      +

      updated_on

      +
      public String updated_on
      +
      An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    @@ -242,10 +252,10 @@

    VerifyResponse.Status

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -290,5 +300,6 @@

      VerifyResponse.Status

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/response/VerifyResponse.Verify.html b/doc/com/telesign/verify/response/VerifyResponse.Verify.html index 7d92be9..0733598 100644 --- a/doc/com/telesign/verify/response/VerifyResponse.Verify.html +++ b/doc/com/telesign/verify/response/VerifyResponse.Verify.html @@ -2,9 +2,9 @@ - + VerifyResponse.Verify - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    • Detail: 
      • @@ -84,7 +84,7 @@

      Class VerifyResponse.Verif

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.verify.response.VerifyResponse.Verify
        • @@ -101,7 +101,8 @@

        Class VerifyResponse.Verif 

        public static class VerifyResponse.Verify
-extends java.lang.Object
        +extends Object +
        An object that describes the verification status.

    @@ -121,12 +122,16 @@

    Field Summary

    Field and Description -java.lang.String -code_entered  +String +code_entered +
    Always set to an empty string.
    + -java.lang.String -code_state  +String +code_state +
    Indicates whether the verification code entered matches that which was sent.
    + @@ -155,11 +160,11 @@

    Constructor Summary

    Method Summary

    @@ -175,22 +180,24 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      code_state

      -
      public java.lang.String code_state
      +

      code_entered

      +
      public String code_entered
      +
      Always set to an empty string.
    - +
    • -

      code_entered

      -
      public java.lang.String code_entered
      +

      code_state

      +
      public String code_state
      +
      Indicates whether the verification code entered matches that which was sent. Possible values are VALID, INVALID, or UNKNOWN. When the code entered matches the code sent, the response will be VALID. When the code entered does not match the code sent, code_state will be INVALID.
    @@ -229,10 +236,10 @@

    VerifyResponse.Verify

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Detail: 
      • @@ -277,5 +284,6 @@

      VerifyResponse.Verify

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/response/VerifyResponse.html b/doc/com/telesign/verify/response/VerifyResponse.html index 5797dfe..0dd26af 100644 --- a/doc/com/telesign/verify/response/VerifyResponse.html +++ b/doc/com/telesign/verify/response/VerifyResponse.html @@ -2,9 +2,9 @@ - + VerifyResponse - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -84,7 +84,7 @@

      Class VerifyResponse

      -
    • java.lang.Object
      • +
    • Object
      • com.telesign.verify.response.VerifyResponse
        • @@ -97,15 +97,8 @@

        Class VerifyResponse


        public class VerifyResponse
-extends java.lang.Object
        -
        Google GSON mapped class to represent a TeleSign JSON response to a - Verify.sms(), Verify.call() and Verify.status() requests - - - Copyright (c) TeleSign Corporation 2012. - License: MIT - Support email address "support@telesign.com" - Author: jweatherford
        +extends Object +
        The VerifyResponse class encapsulates all of the information returned from a call to either the Verify SMS web service, or to the Verify Call web service.
    @@ -126,15 +119,21 @@

    Nested Class Summary

    static class  -VerifyResponse.Error  +VerifyResponse.Error +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    + static class  -VerifyResponse.Status  +VerifyResponse.Status +
    An object containing details about the request status.
    + static class  -VerifyResponse.Verify  +VerifyResponse.Verify +
    An object that describes the verification status.
    + @@ -153,27 +152,39 @@

    Field Summary

    VerifyResponse.Error[] -errors  +errors +
    An array of VerifyResponse.Error objects.
    + -java.lang.String -reference_id  +String +reference_id +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    + -java.lang.String -resource_uri  +String +resource_uri +
    A String containing the URI for accesses the PhoneID resource.
    + VerifyResponse.Status -status  +status +
    An object containing details about the request status.
    + -java.lang.String -sub_resource  +String +sub_resource +
    A String containing the name of the subresource that was accessed.
    + VerifyResponse.Verify -verify  +verify +
    An object that describes the verification status.
    + @@ -208,16 +219,18 @@

    Method Summary

    Method and Description -java.lang.String -toString()  +String +toString() +
    Converts a VerifyResponse object to its equivalent JSON format.
    + @@ -233,49 +246,54 @@

    Methods inherited from class java.lang.Object

    Field Detail

    - +
    • -

      reference_id

      -
      public java.lang.String reference_id
      +

      errors

      +
      public VerifyResponse.Error[] errors
      +
      An array of VerifyResponse.Error objects. Each Error object contains information about an error condition that might have resulted from the Request.
    - +
    • -

      resource_uri

      -
      public java.lang.String resource_uri
      +

      reference_id

      +
      public String reference_id
      +
      A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    - +
    • -

      sub_resource

      -
      public java.lang.String sub_resource
      +

      resource_uri

      +
      public String resource_uri
      +
      A String containing the URI for accesses the PhoneID resource.
    - + - +
    • -

      status

      -
      public VerifyResponse.Status status
      +

      sub_resource

      +
      public String sub_resource
      +
      A String containing the name of the subresource that was accessed. For example, "standard".
    @@ -285,6 +303,7 @@

    status

  • verify

    public VerifyResponse.Verify verify
    +
    An object that describes the verification status.
    • @@ -318,11 +337,12 @@

    Method Detail

    • toString

      -
      public java.lang.String toString()
      +
      public String toString()
      +
      Converts a VerifyResponse object to its equivalent JSON format.
      Overrides:
      -
      toString in class java.lang.Object
      -
      +
      toString in class Object
      +
      Returns:
      A string containing the response from the TeleSign server, in JSON format.
      See Also:
      Object.toString()
    @@ -344,10 +364,10 @@

    toString

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -392,5 +412,6 @@

      toString

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/response/class-use/VerifyResponse.Error.html b/doc/com/telesign/verify/response/class-use/VerifyResponse.Error.html index d8ac97f..3b68bae 100644 --- a/doc/com/telesign/verify/response/class-use/VerifyResponse.Error.html +++ b/doc/com/telesign/verify/response/class-use/VerifyResponse.Error.html @@ -2,9 +2,9 @@ - + Uses of Class com.telesign.verify.response.VerifyResponse.Error - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
    +
    DocBuild:
    +
    TeleSign Java SDK v1.0
      @@ -64,6 +64,11 @@

      Package com.telesign.verify.response

      +
      +
      + Contains a class that represents the TeleSign server response object for the Phone Verify web service.
      +
      +

      See: Description

        @@ -78,29 +83,38 @@

        Package com.telesign.verify.response

        VerifyResponse -
        Google GSON mapped class to represent a TeleSign JSON response to a - Verify.sms(), Verify.call() and Verify.status() requests - - - Copyright (c) TeleSign Corporation 2012.
        +
        The VerifyResponse class encapsulates all of the information returned from a call to either the Verify SMS web service, or to the Verify Call web service.
        VerifyResponse.Error -  + +
        An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
        + VerifyResponse.Status -  + +
        An object containing details about the request status.
        + VerifyResponse.Verify -  + +
        An object that describes the verification status.
        +
      + + + +

      Package com.telesign.verify.response Description

      +

      + Contains a class that represents the TeleSign server response object for the Phone Verify web service. +

      @@ -114,10 +128,10 @@

      Package com.telesign.verify.response

    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    DocBuild:
      @@ -147,5 +161,6 @@

      Package com.telesign.verify.response

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/com/telesign/verify/response/package-tree.html b/doc/com/telesign/verify/response/package-tree.html index 85e9028..a638eaa 100644 --- a/doc/com/telesign/verify/response/package-tree.html +++ b/doc/com/telesign/verify/response/package-tree.html @@ -2,9 +2,9 @@ - + com.telesign.verify.response Class Hierarchy - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -72,7 +72,7 @@

      Hierarchy For Package com.telesign.verify.response

      Class Hierarchy

        @@ -127,5 +127,6 @@

        Class Hierarchy

      +

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/com/telesign/verify/response/package-use.html b/doc/com/telesign/verify/response/package-use.html index 18d70ad..40797f7 100644 --- a/doc/com/telesign/verify/response/package-use.html +++ b/doc/com/telesign/verify/response/package-use.html @@ -2,9 +2,9 @@ - + Uses of Package com.telesign.verify.response - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    TeleSign Java SDK v1.0
      @@ -77,11 +77,17 @@

      Uses of P com.telesign.verify -  + +
      + Contains the Verify class, which abstracts calls to the TeleSign Verify Web Service.
      + com.telesign.verify.response -  + +
      + Contains a class that represents the TeleSign server response object for the Phone Verify web service.
      + @@ -97,11 +103,7 @@

      Uses of P VerifyResponse -
      Google GSON mapped class to represent a TeleSign JSON response to a - Verify.sms(), Verify.call() and Verify.status() requests - - - Copyright (c) TeleSign Corporation 2012.
      +
      The VerifyResponse class encapsulates all of the information returned from a call to either the Verify SMS web service, or to the Verify Call web service.
      @@ -117,13 +119,19 @@

      Uses of P -VerifyResponse.Error  +VerifyResponse.Error +
      An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
      + -VerifyResponse.Status  +VerifyResponse.Status +
      An object containing details about the request status.
      + -VerifyResponse.Verify  +VerifyResponse.Verify +
      An object that describes the verification status.
      + @@ -142,10 +150,10 @@

      Uses of P
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help

    +
    DocBuild:
      @@ -175,5 +183,6 @@

      Uses of P

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/constant-values.html b/doc/constant-values.html index 06e5f56..40fd018 100644 --- a/doc/constant-values.html +++ b/doc/constant-values.html @@ -2,9 +2,9 @@ - + Constant Field Values - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    +
    DocBuild:
      @@ -111,5 +111,6 @@

      Contents

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/copyright.html b/doc/copyright.html new file mode 100644 index 0000000..292cf67 --- /dev/null +++ b/doc/copyright.html @@ -0,0 +1,38 @@ + + + + + Copyright Statement + + + +
    +
    +

    Copyright Page

    +

    This content is © Copyright , TeleSign Corporation.

    + +

    Disclaimer

    +

    Except where expressly provided otherwise by TeleSign, the materials in this Software Development Kit (SDK) are provided "as is," and TeleSign hereby disclaims all express or implied representations, warranties, guaranties, and conditions, including but not limited to any implied warranties or conditions of merchantability, fitness for a particular purpose, title and non-infringement, except to the extent that such disclaimers are held to be legally invalid. TeleSign makes no representations, warranties, guaranties, or conditions as to the quality, suitability, truth, accuracy, or completeness of any of the materials contained on the website.

    + +

    Limitation of Liability

    +

    TeleSign shall not be liable for any damages suffered as a result of using this SDK. In no event, shall TeleSign be liable for any indirect, punitive, special, incidental, or consequential damage (including but not limited to loss of business, revenue, profits, use, data or other economic advantage), however it arises, whether in an action of contract, negligence or other tortious action, arising out of or in connection with the use or performance of use of this SDK, even if TeleSign has been previously advised of the possibility of such damage. You have sole responsibility for the adequate protection and backup of data and/or equipment used in connection with this SDK, and you will not make a claim against TeleSign for lost data, re-run time, inaccurate output, work delays, or lost profits resulting from the use of these materials. You agree to hold TeleSign harmless from, and you covenant not to sue TeleSign for any claims based on or related to the use of this SDK.

    + +

    Intellectual Property Notices

    +

    TeleSign™ and the TeleSign logo are registered trademarks ®. PhoneID and other TeleSign product names referenced herein are trademarks of TeleSign Corporation, and may be registered in the United States Patent and Trademark Office and in other countries. All other product names, company names, marks, logos, and symbols are trademarks of their respective owners.

    + +

    Digital Millennium Copyright Act Notice

    +

    TeleSign respects the intellectual property rights of others. TeleSign may, in appropriate circumstances and at its sole discretion, terminate the access of users who infringe the copyrights or intellectual property rights of others.

    +
    +
    + + \ No newline at end of file diff --git a/doc/deprecated-list.html b/doc/deprecated-list.html index 7e88388..f5f620c 100644 --- a/doc/deprecated-list.html +++ b/doc/deprecated-list.html @@ -2,9 +2,9 @@ - + Deprecated List - + @@ -33,6 +33,7 @@
  • Index
  • Help
    • +
    TeleSign Java SDK
    v1.0
    +
    {@TODAY}
      diff --git a/doc/help-doc.html b/doc/help-doc.html index d40bf84..0609f08 100644 --- a/doc/help-doc.html +++ b/doc/help-doc.html @@ -2,9 +2,9 @@ - + API Help - + @@ -29,10 +29,10 @@
    • Class
    • Use
    • Tree
      • -
    • Deprecated
    • Index
    • Help
    +
    TeleSign Java SDK v1.0
      @@ -142,10 +142,6 @@

      Tree (Class Hierarchy)

  • -

    Deprecated API

    -

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    -
    • -

  • Index

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    • @@ -183,10 +179,10 @@

    Constant Field Values

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -216,5 +212,6 @@

      Constant Field Values

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-1.html b/doc/index-files/index-1.html index 8da521e..df49dcc 100644 --- a/doc/index-files/index-1.html +++ b/doc/index-files/index-1.html @@ -2,9 +2,9 @@ - + A-Index - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,29 +62,39 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z 

    A

    addHeader(String, String) - Method in class com.telesign.util.TeleSignRequest
    -
    Add a header to this TeleSign Request.
    +
    Adds an HTTP 1.1 Request header field/value pair to the set of Request + Headers.
    addParam(String, String) - Method in class com.telesign.util.TeleSignRequest
    -
    Add a parameter to the query String.
    +
    Adds an HTTP 1.1 Request parameter attribute/value pair to the set of + Request Parameters.
    address1 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    +
    +
    A string that indicates the first line of the contact’s street address.
    +
    address2 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    +
    +
    A string that indicates the second line of the contact’s street address.
    +
    address3 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    +
    +
    A string that indicates the third line of the contact’s street address.
    +
    address4 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    +
    +
    A string that indicates the fourth line of the contact’s street address.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -97,10 +107,10 @@

    A

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -130,5 +140,6 @@

      A

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-10.html b/doc/index-files/index-10.html index 69c7a5b..ef570ce 100644 --- a/doc/index-files/index-10.html +++ b/doc/index-files/index-10.html @@ -2,15 +2,15 @@ - -N-Index - + +L-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,33 +62,65 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    N

    +

    L

    -
    name - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    -
     
    -
    name - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    -
     
    -
    name - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    -
     
    -
    name - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    -
     
    -
    name - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    -
     
    -
    name - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    -
     
    -
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    +
    lastname - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
    +
    A string that indicates the contact’s last name or family name.
    +
    +
    latitude - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
    +
    +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places.
    +
    +
    latitude - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
    +
    +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places.
    +
    +
    latitude - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
    +
    +
    A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places.
    +
    +
    level - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    +
    +
    A string indicating the severity of the risk.
    +
    +
    live(String, String) - Method in class com.telesign.phoneid.PhoneId
    +
    +
    Returns information about a specified phone number’s state of operation.
    +
    +
    live - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    A JSON object containing details about a specified phone number’s state of operation.
    +
    +
    location - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    An object containing geographical location information associated with the phone number.
    +
    +
    location - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    An object containing geographical location information associated with the phone number.
    +
    +
    location - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    An object containing geographical location information associated with the phone number.
    +
    +
    longitude - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
    +
    +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    +
    +
    longitude - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
    +
    +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    +
    +
    longitude - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
    +
    +
    A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -101,10 +133,10 @@

    N

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -134,5 +166,6 @@

      N

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-11.html b/doc/index-files/index-11.html index b1056fa..68f0c8f 100644 --- a/doc/index-files/index-11.html +++ b/doc/index-files/index-11.html @@ -2,15 +2,15 @@ - -O-Index - + +M-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,21 +62,57 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    O

    +

    M

    -
    original - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
    -
     
    -
    original - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
    -
     
    -
    original - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
    -
     
    -
    original - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
    -
     
    +
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    +
    +
    The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    +
    +
    The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    +
    +
    The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    +
    +
    The maximum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    metro_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S.
    +
    +
    metro_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S.
    +
    +
    metro_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S.
    +
    +
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    +
    +
    The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    +
    +
    The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    +
    +
    The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    +
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    +
    +
    The minimum number of digits allowed for phone numbers with this particular Country Dialing Code.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -89,10 +125,10 @@

    O

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -122,5 +158,6 @@

      O

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-12.html b/doc/index-files/index-12.html index 1ca2719..4fb112d 100644 --- a/doc/index-files/index-12.html +++ b/doc/index-files/index-12.html @@ -2,15 +2,15 @@ - -P-Index - + +N-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,257 +62,53 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    P

    +

    N

    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    -
     
    -
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    -
     
    -
    phone_type - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    phone_type - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    phone_type - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    PhoneId - Class in com.telesign.phoneid
    +
    name - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    -
    Copyright (c) TeleSign Corporation 2012.
    +
    The Country Name associated with phone number.
    -
    PhoneId(String, String) - Constructor for class com.telesign.phoneid.PhoneId
    +
    name - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    -
    Implementation of the TeleSign PhoneId api
    +
    A string identifying the Time Zone Name (TZ) associated with the phone number (U.S.
    -
    PhoneIdContactResponse - Class in com.telesign.phoneid.response
    +
    name - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    -
    Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.contact() request - - Copyright (c) TeleSign Corporation 2012.
    +
    The Country Name associated with phone number.
    -
    PhoneIdContactResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    PhoneIdContactResponse.Contact - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Contact() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    -
    PhoneIdContactResponse.Error - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Error
    -
     
    -
    PhoneIdContactResponse.Location - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Location() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    PhoneIdContactResponse.Location.Coordinates - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Location.Coordinates() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
    -
     
    -
    PhoneIdContactResponse.Location.Country - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Location.Country() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    -
     
    -
    PhoneIdContactResponse.Location.TimeZone - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Location.TimeZone() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    -
     
    -
    PhoneIdContactResponse.Numbering - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
    -
     
    -
    PhoneIdContactResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber
    -
     
    -
    PhoneIdContactResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    -
     
    -
    PhoneIdContactResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    -
     
    -
    PhoneIdContactResponse.PhoneType - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
    -
     
    -
    PhoneIdContactResponse.Status - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdContactResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    -
     
    -
    PhoneIdLiveResponse - Class in com.telesign.phoneid.response
    +
    name - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    -
    Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.live() request - - Copyright (c) TeleSign Corporation 2012.
    +
    A string identifying the Time Zone Name (TZ) associated with the phone number (U.S.
    -
    PhoneIdLiveResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    PhoneIdLiveResponse.Error - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Error
    -
     
    -
    PhoneIdLiveResponse.Live - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Live() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    -
     
    -
    PhoneIdLiveResponse.Location - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Location() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    PhoneIdLiveResponse.Location.Coordinates - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Location.Coordinates() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
    -
     
    -
    PhoneIdLiveResponse.Location.Country - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Location.Country() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    -
     
    -
    PhoneIdLiveResponse.Location.TimeZone - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Location.TimeZone() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    -
     
    -
    PhoneIdLiveResponse.Numbering - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
    -
     
    -
    PhoneIdLiveResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
    -
     
    -
    PhoneIdLiveResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    -
     
    -
    PhoneIdLiveResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    -
     
    -
    PhoneIdLiveResponse.PhoneType - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
    -
     
    -
    PhoneIdLiveResponse.Status - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdLiveResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    -
     
    -
    PhoneIdScoreResponse - Class in com.telesign.phoneid.response
    +
    name - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    -
    Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.score() request - - Copyright (c) TeleSign Corporation 2012.
    +
    The Country Name associated with phone number.
    -
    PhoneIdScoreResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    PhoneIdScoreResponse.Error - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Error
    -
     
    -
    PhoneIdScoreResponse.Numbering - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
    -
     
    -
    PhoneIdScoreResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
    -
     
    -
    PhoneIdScoreResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    -
     
    -
    PhoneIdScoreResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    -
     
    -
    PhoneIdScoreResponse.PhoneType - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
    -
     
    -
    PhoneIdScoreResponse.Risk - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Risk() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    -
     
    -
    PhoneIdScoreResponse.Status - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdScoreResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    -
     
    -
    PhoneIdStandardResponse - Class in com.telesign.phoneid.response
    +
    name - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    -
    Google GSON mapped class to represent a TeleSign JSON response to a - PhoneId.standard() request - - Copyright (c) TeleSign Corporation 2012.
    +
    A string identifying the Time Zone Name (TZ) associated with the phone number (U.S.
    -
    PhoneIdStandardResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    PhoneIdStandardResponse.Error - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Error
    -
     
    -
    PhoneIdStandardResponse.Location - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Location() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    PhoneIdStandardResponse.Location.Coordinates - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Location.Coordinates() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
    -
     
    -
    PhoneIdStandardResponse.Location.Country - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Location.Country() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    -
     
    -
    PhoneIdStandardResponse.Location.TimeZone - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Location.TimeZone() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    -
     
    -
    PhoneIdStandardResponse.Numbering - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
    -
     
    -
    PhoneIdStandardResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
    -
     
    -
    PhoneIdStandardResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    -
     
    -
    PhoneIdStandardResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    -
     
    -
    PhoneIdStandardResponse.PhoneType - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
    -
     
    -
    PhoneIdStandardResponse.Status - Class in com.telesign.phoneid.response
    -
     
    -
    PhoneIdStandardResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    -
     
    -
    PhoneUtil - Class in com.telesign.util
    +
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
    Copyright (c) TeleSign Corporation 2012.
    +
    An object containing details about the numbering attributes of the specified phone number.
    +
    +
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    An object containing details about the numbering attributes of the specified phone number.
    +
    +
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    An object containing details about the numbering attributes of the specified phone number.
    +
    +
    numbering - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    An object containing details about the numbering attributes of the specified phone number.
    -
    PhoneUtil() - Constructor for class com.telesign.util.PhoneUtil
    -
     
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -325,10 +121,10 @@

    P

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -358,5 +154,6 @@

      P

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-13.html b/doc/index-files/index-13.html index f47c017..a1e6959 100644 --- a/doc/index-files/index-13.html +++ b/doc/index-files/index-13.html @@ -2,15 +2,15 @@ - -R-Index - + +O-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,41 +62,29 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    R

    +

    O

    -
    recommendation - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    -
     
    -
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    reference_id - Variable in class com.telesign.verify.response.VerifyResponse
    -
     
    -
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    resource_uri - Variable in class com.telesign.verify.response.VerifyResponse
    -
     
    -
    risk - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    roaming - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    -
     
    -
    roaming_country - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    -
     
    +
    original - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    +
    original - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    +
    original - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    +
    original - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -109,10 +97,10 @@

    R

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -142,5 +130,6 @@

      R

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-14.html b/doc/index-files/index-14.html index 61785e0..febca68 100644 --- a/doc/index-files/index-14.html +++ b/doc/index-files/index-14.html @@ -2,15 +2,15 @@ - -S-Index - + +P-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,89 +62,361 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    S

    +

    P

    -
    score(String, String) - Method in class com.telesign.phoneid.PhoneId
    +
    params - Variable in class com.telesign.util.TeleSignRequest
    -
    Make a phoneid score request to TeleSign's public API.
    +
    The set of HTTP 1.1 Request parameter attribute/value pairs.
    -
    score - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    +
    +
    The Base Phone Number.
    +
    +
    phone_number - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number.
    +
    +
    phone_type - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    An object that contains details about the phone type.
    +
    +
    phone_type - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    An object that contains details about the phone type.
    +
    +
    phone_type - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    An object that contains details about the phone type.
    +
    +
    PhoneId - Class in com.telesign.phoneid
    +
    +
    The PhoneId class abstracts your interactions with the TeleSign PhoneID web service.
    +
    +
    PhoneId(String, String) - Constructor for class com.telesign.phoneid.PhoneId
    +
    +
    The PhoneId class constructor.
    +
    +
    PhoneIdContactResponse - Class in com.telesign.phoneid.response
    +
    +
    The PhoneIdContactResponse class encapsulates all of the information returned from a call to the PhoneID Contact web service.
    +
    +
    PhoneIdContactResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse
    +
     
    +
    PhoneIdContactResponse.Contact - Class in com.telesign.phoneid.response
    +
    +
    An object that describes data associated with the contact specified in the request.
    +
    +
    PhoneIdContactResponse.Contact() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
     
    +
    PhoneIdContactResponse.Error - Class in com.telesign.phoneid.response
    +
    +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    +
    +
    PhoneIdContactResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Error
    +
     
    +
    PhoneIdContactResponse.Location - Class in com.telesign.phoneid.response
    +
    +
    An object containing geographical location information associated with the phone number.
    +
    +
    PhoneIdContactResponse.Location() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
     
    +
    PhoneIdContactResponse.Location.Coordinates - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    +
    +
    PhoneIdContactResponse.Location.Coordinates() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
    +
     
    +
    PhoneIdContactResponse.Location.Country - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the country associated with the phone number.
    +
    +
    PhoneIdContactResponse.Location.Country() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    +
     
    +
    PhoneIdContactResponse.Location.TimeZone - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the Time Zone associated with the phone number.
    +
    +
    PhoneIdContactResponse.Location.TimeZone() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    +
     
    +
    PhoneIdContactResponse.Numbering - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the numbering attributes of the specified phone number.
    +
    +
    PhoneIdContactResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
    +
     
    +
    PhoneIdContactResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    PhoneIdContactResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber
    +
     
    +
    PhoneIdContactResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    +
    +
    An object containing cleansing details about a phone number.
    +
    +
    PhoneIdContactResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    +
     
    +
    PhoneIdContactResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    +
    PhoneIdContactResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    +
     
    +
    PhoneIdContactResponse.PhoneType - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the phone type.
    +
    +
    PhoneIdContactResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
    +
     
    +
    PhoneIdContactResponse.Status - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the request status.
    +
    +
    PhoneIdContactResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    +
     
    +
    PhoneIdLiveResponse - Class in com.telesign.phoneid.response
    +
    +
    The PhoneIdLiveResponse class encapsulates all of the information returned from a call to the PhoneID Live web service.
    +
    +
    PhoneIdLiveResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
     
    +
    PhoneIdLiveResponse.Error - Class in com.telesign.phoneid.response
    +
    +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    +
    +
    PhoneIdLiveResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Error
    +
     
    +
    PhoneIdLiveResponse.Live - Class in com.telesign.phoneid.response
    +
    +
    A JSON object containing details about a specified phone number’s state of operation.
    +
    +
    PhoneIdLiveResponse.Live() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
     
    +
    PhoneIdLiveResponse.Location - Class in com.telesign.phoneid.response
    +
    +
    An object containing geographical location information associated with the phone number.
    +
    +
    PhoneIdLiveResponse.Location() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
     
    +
    PhoneIdLiveResponse.Location.Coordinates - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    +
    +
    PhoneIdLiveResponse.Location.Coordinates() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
    +
     
    +
    PhoneIdLiveResponse.Location.Country - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the country associated with the phone number.
    +
    +
    PhoneIdLiveResponse.Location.Country() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    +
     
    +
    PhoneIdLiveResponse.Location.TimeZone - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the Time Zone associated with the phone number.
    +
    +
    PhoneIdLiveResponse.Location.TimeZone() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
     
    -
    setPostBody(String) - Method in class com.telesign.util.TeleSignRequest
    +
    PhoneIdLiveResponse.Numbering - Class in com.telesign.phoneid.response
    -
    Set the body of the request for POST requests
    +
    An object containing details about the numbering attributes of the specified phone number.
    -
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    PhoneIdLiveResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
     
    -
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    PhoneIdLiveResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    PhoneIdLiveResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
     
    -
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    PhoneIdLiveResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    +
    +
    An object containing cleansing details about a phone number.
    +
    +
    PhoneIdLiveResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
     
    -
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    PhoneIdLiveResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    +
    PhoneIdLiveResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
     
    -
    sms - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber
    +
    PhoneIdLiveResponse.PhoneType - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the phone type.
    +
    +
    PhoneIdLiveResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
     
    -
    sms - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
    +
    PhoneIdLiveResponse.Status - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the request status.
    +
    +
    PhoneIdLiveResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    +
     
    +
    PhoneIdScoreResponse - Class in com.telesign.phoneid.response
    +
    +
    The PhoneIdScoreResponse class encapsulates all of the information returned from a call to the PhoneID Score web service.
    +
    +
    PhoneIdScoreResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse
     
    -
    sms - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
    +
    PhoneIdScoreResponse.Error - Class in com.telesign.phoneid.response
    +
    +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    +
    +
    PhoneIdScoreResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Error
    +
     
    +
    PhoneIdScoreResponse.Numbering - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the numbering attributes of the specified phone number.
    +
    +
    PhoneIdScoreResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
     
    -
    sms - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
    +
    PhoneIdScoreResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    PhoneIdScoreResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
     
    -
    sms(String) - Method in class com.telesign.verify.Verify
    +
    PhoneIdScoreResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    -
    Convenience method an overload of Verify.sms(String, String, String, String)
    +
    An object containing cleansing details about a phone number.
    -
    sms(String, String) - Method in class com.telesign.verify.Verify
    +
    PhoneIdScoreResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    +
     
    +
    PhoneIdScoreResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    -
    Convenience method an overload of Verify.sms(String, String, String, String)
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    -
    sms(String, String, String, String) - Method in class com.telesign.verify.Verify
    +
    PhoneIdScoreResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    +
     
    +
    PhoneIdScoreResponse.PhoneType - Class in com.telesign.phoneid.response
    -
    Make a Verify SMS request to TeleSign's API.
    +
    An object containing details about the phone type.
    -
    standard(String) - Method in class com.telesign.phoneid.PhoneId
    +
    PhoneIdScoreResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
    +
     
    +
    PhoneIdScoreResponse.Risk - Class in com.telesign.phoneid.response
    -
    Make a phoneid standard request to Telesign's public API.
    +
    An object that describes the risk score for the phone number specified in the request.
    -
    state - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    PhoneIdScoreResponse.Risk() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
     
    -
    state - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    PhoneIdScoreResponse.Status - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the request status.
    +
    +
    PhoneIdScoreResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
     
    -
    state - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    PhoneIdStandardResponse - Class in com.telesign.phoneid.response
    +
    +
    The PhoneIdStandardResponse class encapsulates all of the information returned from a call to the PhoneID Standard web service.
    +
    +
    PhoneIdStandardResponse() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse
     
    -
    state_province - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
    PhoneIdStandardResponse.Error - Class in com.telesign.phoneid.response
    +
    +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    +
    +
    PhoneIdStandardResponse.Error() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Error
     
    -
    status - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    PhoneIdStandardResponse.Location - Class in com.telesign.phoneid.response
    +
    +
    An object containing geographical location information associated with the phone number.
    +
    +
    PhoneIdStandardResponse.Location() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
     
    -
    status - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    PhoneIdStandardResponse.Location.Coordinates - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    +
    +
    PhoneIdStandardResponse.Location.Coordinates() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
     
    -
    status - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    PhoneIdStandardResponse.Location.Country - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the country associated with the phone number.
    +
    +
    PhoneIdStandardResponse.Location.Country() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
     
    -
    status - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    PhoneIdStandardResponse.Location.TimeZone - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the Time Zone associated with the phone number.
    +
    +
    PhoneIdStandardResponse.Location.TimeZone() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
     
    -
    status - Variable in class com.telesign.verify.response.VerifyResponse
    +
    PhoneIdStandardResponse.Numbering - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the numbering attributes of the specified phone number.
    +
    +
    PhoneIdStandardResponse.Numbering() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
     
    -
    status(String) - Method in class com.telesign.verify.Verify
    +
    PhoneIdStandardResponse.Numbering.CleansingNumber - Class in com.telesign.phoneid.response
    -
    Return the results of the post referenced by the reference_id.
    +
    An object containing details about how the phone number was cleansed.
    -
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    PhoneIdStandardResponse.Numbering.CleansingNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
     
    -
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    PhoneIdStandardResponse.Numbering.CleansingNumber.Number - Class in com.telesign.phoneid.response
    +
    +
    An object containing cleansing details about a phone number.
    +
    +
    PhoneIdStandardResponse.Numbering.CleansingNumber.Number() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
     
    -
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    PhoneIdStandardResponse.Numbering.OriginalNumber - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the original phone number passed to TeleSign’s PhoneID API.
    +
    +
    PhoneIdStandardResponse.Numbering.OriginalNumber() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
     
    -
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    PhoneIdStandardResponse.PhoneType - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the phone type.
    +
    +
    PhoneIdStandardResponse.PhoneType() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
     
    -
    sub_resource - Variable in class com.telesign.verify.response.VerifyResponse
    +
    PhoneIdStandardResponse.Status - Class in com.telesign.phoneid.response
    +
    +
    An object containing details about the request status.
    +
    +
    PhoneIdStandardResponse.Status() - Constructor for class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
     
    -
    subscriber_status - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
    PhoneUtil - Class in com.telesign.util
    +
    +
    The PhoneUtil class contains a mentod for normalizing phone numbers.
    +
    +
    PhoneUtil() - Constructor for class com.telesign.util.PhoneUtil
     
    +
    post - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    A boolean value indicates the Request Method.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -157,10 +429,10 @@

    S

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -190,5 +462,6 @@

      S

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-15.html b/doc/index-files/index-15.html index 1181cfd..0468b2c 100644 --- a/doc/index-files/index-15.html +++ b/doc/index-files/index-15.html @@ -2,15 +2,15 @@ - -T-Index - + +R-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,37 +62,73 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    T

    +

    R

    -
    TeleSignRequest - Class in com.telesign.util
    +
    recommendation - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    -
    Copyright (c) TeleSign Corporation 2012.
    +
    A string indicating the action that TeleSign recommends that you take based on the risk score.
    -
    TeleSignRequest(String, String, String, String, String) - Constructor for class com.telesign.util.TeleSignRequest
    +
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
    The TeleSignRequest is the base for which all the TeleSign API requests.
    +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    +
    +
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    +
    +
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    +
    +
    reference_id - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    +
    +
    reference_id - Variable in class com.telesign.verify.response.VerifyResponse
    +
    +
    A String containing a reference identifier that uniquely identifies the Request message that initiated this Response.
    +
    +
    resource - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    The name of the network resource.
    +
    +
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    A String containing the URI for accesses the PhoneID resource.
    +
    +
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    A String containing the URI for accesses the PhoneID resource.
    +
    +
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    A String containing the URI for accesses the PhoneID resource.
    +
    +
    resource_uri - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    A String containing the URI for accesses the PhoneID resource.
    +
    +
    resource_uri - Variable in class com.telesign.verify.response.VerifyResponse
    +
    +
    A String containing the URI for accesses the PhoneID resource.
    +
    +
    risk - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    An object that describes the risk score for the phone number specified in the request.
    +
    +
    roaming - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
    +
    A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area.
    +
    +
    roaming_country - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
    +
    The country in which the mobile device is roaming.
    -
    time_zone - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    time_zone - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    time_zone - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    toString() - Method in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    toString() - Method in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    toString() - Method in class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    toString() - Method in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    toString() - Method in class com.telesign.verify.response.VerifyResponse
    -
     
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -105,10 +141,10 @@

    T

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -138,5 +174,6 @@

      T

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-16.html b/doc/index-files/index-16.html index 64f2bd5..72c9f7b 100644 --- a/doc/index-files/index-16.html +++ b/doc/index-files/index-16.html @@ -2,15 +2,15 @@ - -U-Index - + +S-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,35 +62,146 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    U

    +

    S

    -
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    +
    score(String, String) - Method in class com.telesign.phoneid.PhoneId
    +
    +
    Returns risk information about a specified phone number, including a real-time risk score, threat level, and recommendation for action.
    +
    +
    score - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    +
    +
    One of the Score values.
    +
    +
    secret_key - Variable in class com.telesign.phoneid.PhoneId
     
    -
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    -
     
    -
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    -
     
    -
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    -
     
    -
    updated_on - Variable in class com.telesign.verify.response.VerifyResponse.Status
    -
     
    -
    utc_offset_max - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    -
     
    -
    utc_offset_max - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    -
     
    -
    utc_offset_max - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    -
     
    -
    utc_offset_min - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    -
     
    -
    utc_offset_min - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    -
     
    -
    utc_offset_min - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    +
    secret_key - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    Your TeleSign Secret Shared Key (available from the TeleSign Client + Portal).
    +
    +
    secret_key - Variable in class com.telesign.verify.Verify
     
    +
    setPostBody(String) - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Sets the entity body of an HTTP 1.1 POST Request message.
    +
    +
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    A String containing the Signature, exactly as it was sent in the Request.
    +
    +
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    A String containing the Signature, exactly as it was sent in the Request.
    +
    +
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    A String containing the Signature, exactly as it was sent in the Request.
    +
    +
    signature_string - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    A String containing the Signature, exactly as it was sent in the Request.
    +
    +
    sms - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving text messages.
    +
    +
    sms - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving text messages.
    +
    +
    sms - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving text messages.
    +
    +
    sms - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving text messages.
    +
    +
    sms(String) - Method in class com.telesign.verify.Verify
    +
    +
    Delivers a verification code to the end user by sending it in a text message.
    +
    +
    sms(String, String) - Method in class com.telesign.verify.Verify
    +
    +
    Delivers a verification code to the end user by sending it in a text message.
    +
    +
    sms(String, String, String, String) - Method in class com.telesign.verify.Verify
    +
    +
    Delivers a verification code to the end user by sending it in a text message.
    +
    +
    standard(String) - Method in class com.telesign.phoneid.PhoneId
    +
    +
    Returns information about a specified phone number’s type, numbering structure, cleansing details, and location details.
    +
    +
    state - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    +
    +
    state - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    +
    +
    state - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only).
    +
    +
    state_province - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
    +
    A string that indicates the state, province, or region in which the contact is located.
    +
    +
    status - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    An object containing details about the request status.
    +
    +
    status - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    An object containing details about the request status.
    +
    +
    status - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    An object containing details about the request status.
    +
    +
    status - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    An object containing details about the request status.
    +
    +
    status - Variable in class com.telesign.verify.response.VerifyResponse
    +
    +
    An object containing details about the request status.
    +
    +
    status(String) - Method in class com.telesign.verify.Verify
    +
    +
    Retrieves the status of a phone verification (for either SMS or Call).
    +
    +
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    A String containing the name of the subresource that was accessed.
    +
    +
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    A String containing the name of the subresource that was accessed.
    +
    +
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    A String containing the name of the subresource that was accessed.
    +
    +
    sub_resource - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    A String containing the name of the subresource that was accessed.
    +
    +
    sub_resource - Variable in class com.telesign.verify.response.VerifyResponse
    +
    +
    A String containing the name of the subresource that was accessed.
    +
    +
    subscriber_status - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
    +
    A string indicating the current status of the subscriber’s phone number.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -103,10 +214,10 @@

    U

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -136,5 +247,6 @@

      U

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-17.html b/doc/index-files/index-17.html index a39657a..d1c389c 100644 --- a/doc/index-files/index-17.html +++ b/doc/index-files/index-17.html @@ -2,15 +2,15 @@ - -V-Index - + +T-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,45 +62,63 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    V

    +

    T

    -
    verify - Variable in class com.telesign.verify.response.VerifyResponse
    -
     
    -
    Verify - Class in com.telesign.verify
    +
    TeleSignRequest - Class in com.telesign.util
    -
    Copyright (c) TeleSign Corporation 2012.
    +
    The TeleSignRequest class is an abstraction for creating and sending HTTP 1.1 + REST Requests for TeleSign web services.
    -
    Verify(String, String) - Constructor for class com.telesign.verify.Verify
    +
    TeleSignRequest(String, String, String, String, String) - Constructor for class com.telesign.util.TeleSignRequest
    -
    Implementation of the TeleSign Verify api
    +
    The TeleSitgnRequest class constructor.
    -
    VerifyResponse - Class in com.telesign.verify.response
    +
    time_zone - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
    Google GSON mapped class to represent a TeleSign JSON response to a - Verify.sms(), Verify.call() and Verify.status() requests - - - Copyright (c) TeleSign Corporation 2012.
    +
    An object containing details about the Time Zone associated with the phone number.
    +
    +
    time_zone - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    An object containing details about the Time Zone associated with the phone number.
    +
    +
    time_zone - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    An object containing details about the Time Zone associated with the phone number.
    +
    +
    toString() - Method in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    Converts a PhoneIdContactResponse object to its equivalent JSON format, using the Gson class library.
    +
    +
    toString() - Method in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    Converts a PhoneIdLiveResponse object to its equivalent JSON format, using the Gson class library.
    +
    +
    toString() - Method in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    Converts a PhoneIdScoreResponse object to its equivalent JSON format.
    +
    +
    toString() - Method in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    Converts a PhoneIdStandardResponse object to its equivalent JSON format, using the Gson class library.
    +
    +
    toString() - Method in class com.telesign.verify.response.VerifyResponse
    +
    +
    Converts a VerifyResponse object to its equivalent JSON format.
    +
    +
    ts_date - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    A boolean value that indicates whether the TeleSign-specific + Date Request header field is used.
    +
    +
    ts_headers - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    The set of TeleSign-specific Request header field/value pairs.
    -
    VerifyResponse() - Constructor for class com.telesign.verify.response.VerifyResponse
    -
     
    -
    VerifyResponse.Error - Class in com.telesign.verify.response
    -
     
    -
    VerifyResponse.Error() - Constructor for class com.telesign.verify.response.VerifyResponse.Error
    -
     
    -
    VerifyResponse.Status - Class in com.telesign.verify.response
    -
     
    -
    VerifyResponse.Status() - Constructor for class com.telesign.verify.response.VerifyResponse.Status
    -
     
    -
    VerifyResponse.Verify - Class in com.telesign.verify.response
    -
     
    -
    VerifyResponse.Verify() - Constructor for class com.telesign.verify.response.VerifyResponse.Verify
    -
     
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -113,10 +131,10 @@

    V

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -146,5 +164,6 @@

      V

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-18.html b/doc/index-files/index-18.html index 32ec0b6..5c6ae0b 100644 --- a/doc/index-files/index-18.html +++ b/doc/index-files/index-18.html @@ -2,15 +2,15 @@ - -Z-Index - + +U-Index + @@ -29,15 +29,15 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    Z

    +

    U

    -
    zip - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    zip - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    zip - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    zip_postal_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    +
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    +
    +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    +
    +
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    +
    +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    +
    +
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    +
    +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    +
    +
    updated_on - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    +
    +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    +
    +
    updated_on - Variable in class com.telesign.verify.response.VerifyResponse.Status
    +
    +
    An ISO 8601 UTC timestamp indicating when the transaction status was updated.
    +
    +
    url - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    The absolute form of the Resource URI
    +
    +
    utc_offset_max - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    +
    +
    For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number.
    +
    +
    utc_offset_max - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    +
    +
    For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number.
    +
    +
    utc_offset_max - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    +
    +
    For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number.
    +
    +
    utc_offset_min - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.TimeZone
    +
    +
    For U.S.
    +
    +
    utc_offset_min - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.TimeZone
    +
    +
    For U.S.
    +
    +
    utc_offset_min - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.TimeZone
    +
    +
    For U.S.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -89,15 +129,15 @@

    Z

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
    • Frames
      • @@ -122,5 +162,6 @@

      Z

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-19.html b/doc/index-files/index-19.html new file mode 100644 index 0000000..3b95c1b --- /dev/null +++ b/doc/index-files/index-19.html @@ -0,0 +1,155 @@ + + + + + +V-Index + + + + + + + +
    + + + + + +
    TeleSign Java SDK v1.0
    +
    +
    + + + +
    + +
    + + +
    + +
    A B C D E F G H I L M N O P R S T U V Z  + + +

    V

    +
    +
    verify - Variable in class com.telesign.verify.response.VerifyResponse
    +
    +
    An object that describes the verification status.
    +
    +
    Verify - Class in com.telesign.verify
    +
    +
    The Verify class abstracts your interactions with the TeleSign Verify web service.
    +
    +
    Verify(String, String) - Constructor for class com.telesign.verify.Verify
    +
    +
    The Verify class constructor.
    +
    +
    VerifyResponse - Class in com.telesign.verify.response
    +
    +
    The VerifyResponse class encapsulates all of the information returned from a call to either the Verify SMS web service, or to the Verify Call web service.
    +
    +
    VerifyResponse() - Constructor for class com.telesign.verify.response.VerifyResponse
    +
     
    +
    VerifyResponse.Error - Class in com.telesign.verify.response
    +
    +
    An array of property-value pairs, that contain information on error conditions that might have resulted from the Request.
    +
    +
    VerifyResponse.Error() - Constructor for class com.telesign.verify.response.VerifyResponse.Error
    +
     
    +
    VerifyResponse.Status - Class in com.telesign.verify.response
    +
    +
    An object containing details about the request status.
    +
    +
    VerifyResponse.Status() - Constructor for class com.telesign.verify.response.VerifyResponse.Status
    +
     
    +
    VerifyResponse.Verify - Class in com.telesign.verify.response
    +
    +
    An object that describes the verification status.
    +
    +
    VerifyResponse.Verify() - Constructor for class com.telesign.verify.response.VerifyResponse.Verify
    +
     
    +
    +A B C D E F G H I L M N O P R S T U V Z 
    + +
    + + + + + +
    DocBuild:
    +
    +
    + + + +
    + +
    + + +
    + +

    Copyright © , TeleSign Corp., All rights reserved.

    + + diff --git a/doc/index-files/index-2.html b/doc/index-files/index-2.html index f2a5bfb..564c1ce 100644 --- a/doc/index-files/index-2.html +++ b/doc/index-files/index-2.html @@ -2,15 +2,15 @@ - -C-Index - + +B-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,149 +62,21 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    C

    +

    B

    -
    call - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber
    -
     
    -
    call - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
    -
     
    -
    call - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
    -
     
    -
    call - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
    -
     
    -
    call(String) - Method in class com.telesign.verify.Verify
    +
    base - Variable in class com.telesign.util.TeleSignRequest
    -
    Convenience method for Verify.call(String, String, String, String, int, String, boolean)
    +
    The Base URI.
    -
    call(String, String) - Method in class com.telesign.verify.Verify
    +
    body - Variable in class com.telesign.util.TeleSignRequest
    -
    Convenience method for Verify.call(String, String, String, String, int, String, boolean)
    +
    The contents of the entity body in the POST Request.
    -
    call(String, String, String, String, int, String, boolean) - Method in class com.telesign.verify.Verify
    -
    -
    Make a Verify API call to TeleSigns phone service.
    -
    -
    city - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    -
    city - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    city - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    city - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    -
     
    -
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    -
     
    -
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    -
     
    -
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    -
     
    -
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
    -
     
    -
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
    -
     
    -
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
    -
     
    -
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Error
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Error
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Error
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Error
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
    -
     
    -
    code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    -
     
    -
    code - Variable in class com.telesign.verify.response.VerifyResponse.Error
    -
     
    -
    code - Variable in class com.telesign.verify.response.VerifyResponse.Status
    -
     
    -
    code_entered - Variable in class com.telesign.verify.response.VerifyResponse.Verify
    -
     
    -
    code_state - Variable in class com.telesign.verify.response.VerifyResponse.Verify
    -
     
    -
    com.telesign.phoneid - package com.telesign.phoneid
    -
     
    -
    com.telesign.phoneid.response - package com.telesign.phoneid.response
    -
     
    -
    com.telesign.util - package com.telesign.util
    -
     
    -
    com.telesign.verify - package com.telesign.verify
    -
     
    -
    com.telesign.verify.response - package com.telesign.verify.response
    -
     
    -
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    -
     
    -
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    -
     
    -
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    -
     
    -
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    -
     
    -
    contact(String, String) - Method in class com.telesign.phoneid.PhoneId
    -
    -
    Make a phoneid contact request to TeleSign's public API.
    -
    -
    contact - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    coordinates - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    coordinates - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    coordinates - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    country - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    -
    country - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    country - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    country - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    -
     
    -
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    -
     
    -
    county - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    county - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    county - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -217,10 +89,10 @@

    C

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -250,5 +122,6 @@

      C

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-20.html b/doc/index-files/index-20.html new file mode 100644 index 0000000..8b62c66 --- /dev/null +++ b/doc/index-files/index-20.html @@ -0,0 +1,135 @@ + + + + + +Z-Index + + + + + + + +
    + + + + + +
    TeleSign Java SDK v1.0
    +
    +
    + + + +
    + +
    + + +
    + +
    A B C D E F G H I L M N O P R S T U V Z  + + +

    Z

    +
    +
    zip - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S.
    +
    +
    zip - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S.
    +
    +
    zip - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S.
    +
    +
    zip_postal_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
    +
    A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only).
    +
    +
    +A B C D E F G H I L M N O P R S T U V Z 
    + +
    + + + + + +
    DocBuild:
    +
    +
    + + + +
    + +
    + + +
    + +

    Copyright © , TeleSign Corp., All rights reserved.

    + + diff --git a/doc/index-files/index-3.html b/doc/index-files/index-3.html index 542990e..f1138f9 100644 --- a/doc/index-files/index-3.html +++ b/doc/index-files/index-3.html @@ -2,15 +2,15 @@ - -D-Index - + +C-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,43 +62,286 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    D

    +

    C

    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Error
    +
    call - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving voice calls.
    +
    +
    call - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving voice calls.
    +
    +
    call - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving voice calls.
    +
    +
    call - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber
    +
    +
    An object containing cleansing details about a phone number used for receiving voice calls.
    +
    +
    call(String) - Method in class com.telesign.verify.Verify
    +
    +
    Delivers a verification code to the end user with a phone call.
    +
    +
    call(String, String) - Method in class com.telesign.verify.Verify
    +
    +
    Delivers a verification code to the end user with a phone call.
    +
    +
    call(String, String, String, String, int, String, boolean) - Method in class com.telesign.verify.Verify
    +
    +
    Delivers a verification code to the end user with a phone call.
    +
    +
    city - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
    +
    A string that indicates the city in which the contact is located.
    +
    +
    city - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    A string specifying the name of the city associated with the phone number.
    +
    +
    city - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    A string specifying the name of the city associated with the phone number.
    +
    +
    city - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    A string specifying the name of the city associated with the phone number.
    +
    +
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    +
    +
    One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
    +
    +
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    +
    +
    One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
    +
    +
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    +
    +
    One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
    +
    +
    cleansed_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    +
    +
    One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number.
    +
    +
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    cleansing - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering
    +
    +
    An object containing details about how the phone number was cleansed.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Error
    +
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
    +
    +
    One of the Phone Type Codes."
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    +
    +
    One of the Transaction Status Codes.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Error
    +
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
    +
    +
    One of the Phone Type Codes."
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    +
    +
    One of the Transaction Status Codes.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Error
    +
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
    +
    +
    One of the Phone Type Codes."
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    +
    +
    One of the Transaction Status Codes.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Error
    +
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
    +
    +
    One of the Phone Type Codes."
    +
    +
    code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    +
    +
    One of the Transaction Status Codes.
    +
    +
    code - Variable in class com.telesign.verify.response.VerifyResponse.Error
    +
    +
    A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred.
    +
    +
    code - Variable in class com.telesign.verify.response.VerifyResponse.Status
    +
    +
    One of the Transaction Status Codes.
    +
    +
    code_entered - Variable in class com.telesign.verify.response.VerifyResponse.Verify
    +
    +
    Always set to an empty string.
    +
    +
    code_state - Variable in class com.telesign.verify.response.VerifyResponse.Verify
    +
    +
    Indicates whether the verification code entered matches that which was sent.
    +
    +
    com.telesign.phoneid - package com.telesign.phoneid
    +
    +
    + Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service.
    +
    +
    com.telesign.phoneid.response - package com.telesign.phoneid.response
    +
    +
    + Contains a set of classes that represent TeleSign server response objects—one for each of the PhoneID web services.
    +
    +
    com.telesign.util - package com.telesign.util
    +
    +
    + Contains a class for normalizing a phone number, and a class that represents a TeleSign service request object.
    +
    +
    com.telesign.verify - package com.telesign.verify
    +
    +
    + Contains the Verify class, which abstracts calls to the TeleSign Verify Web Service.
    +
    +
    com.telesign.verify.response - package com.telesign.verify.response
    +
    +
    + Contains a class that represents the TeleSign server response object for the Phone Verify web service.
    +
    +
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number prefixed with the Country Dialing Code.
    +
    +
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number prefixed with the Country Dialing Code.
    +
    +
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number prefixed with the Country Dialing Code.
    +
    +
    complete_phone_number - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    +
    +
    The Base Phone Number prefixed with the Country Dialing Code.
    +
    +
    connection - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    The persistent session connection for the Request.
    +
    +
    contact(String, String) - Method in class com.telesign.phoneid.PhoneId
    +
    +
    Returns contact details for a specified phone number’s subscriber.
    +
    +
    contact - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    +
    +
    An object that describes data associated with the contact specified in the request.
    +
    +
    coordinates - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    +
    +
    coordinates - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    +
    +
    coordinates - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    An object containing details about the geographical coordinates of the location where the phone number is registered.
    +
    +
    country - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    +
    +
    A string that indicates the country in which the contact is located.
    +
    +
    country - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    An object containing details about the country associated with the phone number.
    +
    +
    country - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    An object containing details about the country associated with the phone number.
    +
    +
    country - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    An object containing details about the country associated with the phone number.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.OriginalNumber
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.OriginalNumber
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.OriginalNumber
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    country_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.OriginalNumber
    +
    +
    A 1, 2, or 3-digit number representing the Country Dialing Code.
    +
    +
    county - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    +
    +
    A string specifying the name of the County (or Parish) associated with the phone number (U.S.
    +
    +
    county - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    +
    +
    A string specifying the name of the County (or Parish) associated with the phone number (U.S.
    +
    +
    county - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    +
    +
    A string specifying the name of the County (or Parish) associated with the phone number (U.S.
    +
    +
    customer_id - Variable in class com.telesign.phoneid.PhoneId
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Error
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Error
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Error
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
    -
     
    -
    description - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    -
     
    -
    description - Variable in class com.telesign.verify.response.VerifyResponse.Error
    -
     
    -
    description - Variable in class com.telesign.verify.response.VerifyResponse.Status
    -
     
    -
    device_status - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
    customer_id - Variable in class com.telesign.util.TeleSignRequest
    +
    +
    Your TeleSign Customer ID.
    +
    +
    customer_id - Variable in class com.telesign.verify.Verify
     
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -111,10 +354,10 @@

    D

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -144,5 +387,6 @@

      D

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-4.html b/doc/index-files/index-4.html index 2223d07..4bbe85a 100644 --- a/doc/index-files/index-4.html +++ b/doc/index-files/index-4.html @@ -2,15 +2,15 @@ - -E-Index - + +D-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,27 +62,73 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    E

    +

    D

    -
    errors - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    errors - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    errors - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    -
     
    -
    errors - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    errors - Variable in class com.telesign.verify.response.VerifyResponse
    -
     
    -
    executeRequest() - Method in class com.telesign.util.TeleSignRequest
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Error
    -
    Sign and make the TeleSign Request to the url that was set on this request.
    +
    A string that describes the type of error that occurred.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.PhoneType
    +
    +
    A description of the phone type.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Status
    +
    +
    A descriptionm of the transaction status.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Error
    +
    +
    A string that describes the type of error that occurred.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.PhoneType
    +
    +
    A description of the phone type.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Status
    +
    +
    A descriptionm of the transaction status.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Error
    +
    +
    A string that describes the type of error that occurred.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.PhoneType
    +
    +
    A description of the phone type.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Status
    +
    +
    A descriptionm of the transaction status.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Error
    +
    +
    A string that describes the type of error that occurred.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.PhoneType
    +
    +
    A description of the phone type.
    +
    +
    description - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Status
    +
    +
    A descriptionm of the transaction status.
    +
    +
    description - Variable in class com.telesign.verify.response.VerifyResponse.Error
    +
    +
    A string that describes the type of error that occurred.
    +
    +
    description - Variable in class com.telesign.verify.response.VerifyResponse.Status
    +
    +
    A descriptionm of the transaction status.
    +
    +
    device_status - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Live
    +
    +
    A string indicating the current status of the phone equipment.
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -95,10 +141,10 @@

    E

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -128,5 +174,6 @@

      E

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-5.html b/doc/index-files/index-5.html index a0efd37..324b48e 100644 --- a/doc/index-files/index-5.html +++ b/doc/index-files/index-5.html @@ -2,15 +2,15 @@ - -F-Index - + +E-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,19 +62,37 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    F

    +

    E

    -
    firstname - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    -
    formatTo11Digits(String) - Static method in class com.telesign.util.PhoneUtil
    +
    errors - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
    helper method to validate numbers to 11 digits
    +
    An array of PhoneIdContactResponse.Error objects.
    +
    +
    errors - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    +
    +
    An array of PhoneIdLiveResponse.Error objects.
    +
    +
    errors - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse
    +
    +
    An array of PhoneIdScoreResponse.Error objects.
    +
    +
    errors - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    +
    +
    An array of PhoneIdStandardResponse.Error objects.
    +
    +
    errors - Variable in class com.telesign.verify.response.VerifyResponse
    +
    +
    An array of VerifyResponse.Error objects.
    +
    +
    executeRequest() - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Creates and sends the REST request.
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -87,10 +105,10 @@

    F

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -120,5 +138,6 @@

      F

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-6.html b/doc/index-files/index-6.html index 90edefc..5e50d6f 100644 --- a/doc/index-files/index-6.html +++ b/doc/index-files/index-6.html @@ -2,15 +2,15 @@ - -G-Index - + +F-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,29 +62,21 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    G

    +

    F

    -
    getAllHeaders() - Method in class com.telesign.util.TeleSignRequest
    +
    firstname - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
    Return a sorted list of all the headers.
    +
    A string that indicates the contact’s first name or given name.
    -
    getAllParams() - Method in class com.telesign.util.TeleSignRequest
    +
    formatTo11Digits(String) - Static method in class com.telesign.util.PhoneUtil
    -
    Return all the Query parameters set on this request.
    -
    -
    getPostBody() - Method in class com.telesign.util.TeleSignRequest
    -
    -
    Get the POST body for this request
    -
    -
    getTsHeaders() - Method in class com.telesign.util.TeleSignRequest
    -
    -
    Return the TeleSign specific Headers set for this request
    +
    This mentod is a helper method for cleansing phone numbers.
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -97,10 +89,10 @@

    G

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -130,5 +122,6 @@

      G

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-7.html b/doc/index-files/index-7.html index deeb36a..80b66da 100644 --- a/doc/index-files/index-7.html +++ b/doc/index-files/index-7.html @@ -2,15 +2,15 @@ - -I-Index - + +G-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,25 +62,34 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    I

    +

    G

    -
    iso2 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    -
     
    -
    iso2 - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    -
     
    -
    iso2 - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    -
     
    -
    iso3 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    -
     
    -
    iso3 - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    -
     
    -
    iso3 - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    -
     
    +
    getAllHeaders() - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Returns the set of both the standard and the + TeleSign-specific Request header fields.
    +
    +
    getAllParams() - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Returns the set of POST Request parameters.
    +
    +
    getPostBody() - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Gets the entity body of an HTTP 1.1 POST Request message.
    +
    +
    getSigningString(String) - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Create the string to sign.
    +
    +
    getTsHeaders() - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Returns the set of TeleSign-specific Request header fields.
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -93,10 +102,10 @@

    I

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -126,5 +135,6 @@

      I

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-8.html b/doc/index-files/index-8.html index 9644a8d..40f0c19 100644 --- a/doc/index-files/index-8.html +++ b/doc/index-files/index-8.html @@ -2,15 +2,15 @@ - -L-Index - + +H-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,41 +62,21 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    L

    +

    H

    -
    lastname - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Contact
    -
     
    -
    latitude - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
    -
     
    -
    latitude - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
    -
     
    -
    latitude - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
    -
     
    -
    level - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Risk
    -
     
    -
    live(String, String) - Method in class com.telesign.phoneid.PhoneId
    +
    headers - Variable in class com.telesign.util.TeleSignRequest
    -
    Make a phoneid live request to TeleSign's public API.
    +
    The set of HTTP 1.1 Request header field/value pairs.
    +
    +
    hmacsha1(String, String) - Method in class com.telesign.util.TeleSignRequest
    +
    +
    Creates the Signature component for the Authorization header field.
    -
    live - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    location - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse
    -
     
    -
    location - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse
    -
     
    -
    location - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse
    -
     
    -
    longitude - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Coordinates
    -
     
    -
    longitude - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Coordinates
    -
     
    -
    longitude - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Coordinates
    -
     
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -109,10 +89,10 @@

    L

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -142,5 +122,6 @@

      L

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index-files/index-9.html b/doc/index-files/index-9.html index 8201639..eeb0226 100644 --- a/doc/index-files/index-9.html +++ b/doc/index-files/index-9.html @@ -2,15 +2,15 @@ - -M-Index - + +I-Index + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -62,35 +62,37 @@
    -
    A C D E F G I L M N O P R S T U V Z  +
    A B C D E F G H I L M N O P R S T U V Z  -

    M

    +

    I

    -
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    -
     
    -
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    -
     
    -
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    -
     
    -
    max_length - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    -
     
    -
    metro_code - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location
    -
     
    -
    metro_code - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location
    -
     
    -
    metro_code - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location
    -
     
    -
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Numbering.CleansingNumber.Number
    -
     
    -
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Numbering.CleansingNumber.Number
    -
     
    -
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdScoreResponse.Numbering.CleansingNumber.Number
    -
     
    -
    min_length - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Numbering.CleansingNumber.Number
    -
     
    +
    iso2 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    +
    +
    The ISO 3166-1 2-letter Country Code associated with the phone number.
    +
    +
    iso2 - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    +
    +
    The ISO 3166-1 2-letter Country Code associated with the phone number.
    +
    +
    iso2 - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    +
    +
    The ISO 3166-1 2-letter Country Code associated with the phone number.
    +
    +
    iso3 - Variable in class com.telesign.phoneid.response.PhoneIdContactResponse.Location.Country
    +
    +
    The ISO 3166-1 3-letter Country Code associated with the phone number
    +
    +
    iso3 - Variable in class com.telesign.phoneid.response.PhoneIdLiveResponse.Location.Country
    +
    +
    The ISO 3166-1 3-letter Country Code associated with the phone number
    +
    +
    iso3 - Variable in class com.telesign.phoneid.response.PhoneIdStandardResponse.Location.Country
    +
    +
    The ISO 3166-1 3-letter Country Code associated with the phone number
    +
    -A C D E F G I L M N O P R S T U V Z 
    +A B C D E F G H I L M N O P R S T U V Z 
    @@ -103,10 +105,10 @@

    M

  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    DocBuild:
      @@ -136,5 +138,6 @@

      M

    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/index.html b/doc/index.html index 486e43a..24237e8 100644 --- a/doc/index.html +++ b/doc/index.html @@ -2,7 +2,7 @@ - + Generated Documentation (Untitled)
      @@ -138,5 +174,6 @@
    +

    Copyright © , TeleSign Corp., All rights reserved.

    diff --git a/doc/overview-tree.html b/doc/overview-tree.html index dbe2da6..fce6f4e 100644 --- a/doc/overview-tree.html +++ b/doc/overview-tree.html @@ -2,9 +2,9 @@ - + Class Hierarchy - + @@ -29,10 +29,10 @@
  • Class
  • Use
  • Tree
    • -
  • Deprecated
  • Index
  • Help
    • +
    TeleSign Java SDK v1.0
      @@ -76,7 +76,7 @@

      Hierarchy For All Packages

      Class Hierarchy

        @@ -182,5 +182,6 @@

        Class Hierarchy

      +

      Copyright © , TeleSign Corp., All rights reserved.

      diff --git a/doc/src-html/com/telesign/phoneid/PhoneId.html b/doc/src-html/com/telesign/phoneid/PhoneId.html new file mode 100644 index 0000000..9e52d96 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/PhoneId.html @@ -0,0 +1,228 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid;
+011
+012import com.google.gson.Gson;
+013import com.telesign.phoneid.response.PhoneIdContactResponse;
+014import com.telesign.phoneid.response.PhoneIdLiveResponse;
+015import com.telesign.phoneid.response.PhoneIdScoreResponse;
+016import com.telesign.phoneid.response.PhoneIdStandardResponse;
+017import com.telesign.util.PhoneUtil;
+018import com.telesign.util.TeleSignRequest;
+019import java.io.IOException;
+020
+021/**
+022 *  The PhoneId class abstracts your interactions with the <em>TeleSign PhoneID web service</em>.
+023 *  A PhoneId object encapsulates your credentials (your TeleSign <em>Customer ID</em> and <em>Secret Key</em>).
+024 */
+025public class PhoneId
+026{
+027        /**
+028         * The PhoneId class constructor.
+029         * Once you instantiate a PhoneId object, you can use it to make instance calls to <em>PhoneID Standard</em>, <em>PhoneID Score</em>, <em>PhoneID Contact</em>, and <em>PhoneID Live</em>.
+030         * @param customer_id   [Required] A string representing your TeleSign Customer ID. This represents your TeleSign account number.
+031         * @param secret_key    [Required] A string representing your TeleSign Secret Key (available from the TeleSign Client Portal).
+032         */
+033        public PhoneId(String customer_id, String secret_key)
+034        {
+035            this.customer_id = customer_id;
+036            this.secret_key = secret_key;
+037        }
+038        
+039        /**
+040         * Returns information about a specified phone number’s type, numbering structure, cleansing details, and location details. 
+041         * @param identifier    [Required] A string representing the phone number you want information about.
+042         * @return              A {@link com.telesign.phoneid.response.PhoneIdStandardResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+043         */
+044        public PhoneIdStandardResponse standard(String identifier)
+045        {
+046                String result = null;
+047                
+048                try
+049                {
+050                        String clean_phone = PhoneUtil.formatTo11Digits(identifier);
+051                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/phoneid/standard/" + clean_phone, "GET", customer_id, secret_key);
+052                        result = tr.executeRequest();
+053                }
+054                catch (IOException e)
+055                {
+056                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+057                }
+058                
+059                Gson gson = new Gson();
+060                PhoneIdStandardResponse response = gson.fromJson(result, PhoneIdStandardResponse.class);
+061                
+062                return response;
+063        }
+064        
+065        /**
+066         * Returns risk information about a specified phone number, including a real-time risk score, threat level, and recommendation for action. 
+067         * @param identifier    [Required] A string representing the phone number you want information about.
+068         * @param ucid          [Required] A string specifying one of the Use Case Codes.
+069         * @return              A {@link com.telesign.phoneid.response.PhoneIdScoreResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+070         */
+071        public PhoneIdScoreResponse score(String identifier, String ucid)
+072        {
+073                String result = null;
+074                
+075                try
+076                {
+077                        String clean_phone = PhoneUtil.formatTo11Digits(identifier);
+078                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/phoneid/score/" + clean_phone, "GET", customer_id, secret_key);
+079                        tr.addParam("ucid", ucid);      
+080                        result = tr.executeRequest();
+081                }
+082                catch (IOException e)
+083                {
+084                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+085                }
+086                
+087                Gson gson = new Gson();
+088                PhoneIdScoreResponse response = gson.fromJson(result, PhoneIdScoreResponse.class);
+089                
+090                return response;
+091        }
+092        
+093        /**
+094         * Returns contact details for a specified phone number’s subscriber. This includes the subscriber's First Name, Last Name, Street Address, City, State (or Province), Country, and ZIP (Postal) Code.
+095         * @param identifier    [Required] A string representing the phone number you want information about.
+096         * @param ucid          [Required] A string specifying one of the Use Case Codes.
+097         * @return              A {@link com.telesign.phoneid.response.PhoneIdContactResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+098         */
+099        public PhoneIdContactResponse contact(String identifier, String ucid)
+100        {
+101                String result = null;
+102                
+103                try
+104                {
+105                        String clean_phone = PhoneUtil.formatTo11Digits(identifier);
+106                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/phoneid/contact/" + clean_phone, "GET", customer_id, secret_key);
+107                        tr.addParam("ucid", ucid);
+108                        
+109                        result = tr.executeRequest();                   
+110                }
+111                catch (IOException e)
+112                {
+113                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+114                }
+115                
+116                Gson gson = new Gson();
+117                PhoneIdContactResponse response = gson.fromJson(result, PhoneIdContactResponse.class);
+118                
+119                return response;
+120        }
+121        
+122        /**
+123         *  Returns information about a specified phone number’s <em>state of operation</em>.
+124         *  You can use it to find out 
+125         *  if the line is in service, 
+126         *  if the number is reachable, 
+127         *  if the mobile phone is roaming, and if so, in which country.
+128         * @param identifier    [Required] A string representing the phone number you want information about.
+129         * @param ucid          [Required] A string specifying one of the Use Case Codes.
+130         * @return              A {@link com.telesign.phoneid.response.PhoneIdContactResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+131         */
+132        public PhoneIdLiveResponse live(String identifier, String ucid)
+133        {
+134                String result = null;
+135                
+136                try
+137                {
+138                        String clean_phone = PhoneUtil.formatTo11Digits(identifier);
+139                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/phoneid/live/" + clean_phone, "GET", customer_id, secret_key);
+140                        tr.addParam("ucid", ucid);      
+141                        result = tr.executeRequest();
+142                }
+143                catch (IOException e)
+144                {
+145                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+146                }
+147                
+148                Gson gson = new Gson();
+149                PhoneIdLiveResponse response = gson.fromJson(result, PhoneIdLiveResponse.class);
+150                
+151                return response;
+152        }
+153        
+154        private final String customer_id;
+155    private final String secret_key;
+156}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Contact.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Error.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Coordinates.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.Country.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.TimeZone.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Location.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.Number.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.CleansingNumber.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.OriginalNumber.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Numbering.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.PhoneType.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.Status.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.html new file mode 100644 index 0000000..5abb097 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdContactResponse.html @@ -0,0 +1,314 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdContactResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Contact</strong> web service.  */
+015public class PhoneIdContactResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /** An object that describes data associated with the contact specified in the request. */
+044        public Contact contact;
+045        
+046        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+047        public static class Error
+048        {
+049                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+050                public int code;
+051                
+052                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+053                public String description;
+054        }
+055
+056        /**  An object containing details about the phone type. */
+057        public static class PhoneType {
+058            
+059                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+060                public int code;
+061                
+062                /**  A description of the phone type. */
+063                public String description;
+064        }
+065
+066        /** An object containing details about the request status. */
+067        public static class Status {
+068                
+069                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+070                public String updated_on;
+071                
+072                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+073                public int code;
+074                
+075                /** A descriptionm of the transaction status. */
+076                public String description;
+077        }
+078
+079        /** An object containing details about the numbering attributes of the specified phone number. */
+080        public static class Numbering {
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public OriginalNumber original;
+084                
+085                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+086                public CleansingNumber cleansing;
+087                
+088                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+089                public static class OriginalNumber {
+090                    
+091                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+092                        public String phone_number;
+093                        
+094                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+095                        public String complete_phone_number;
+096                        
+097                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+098                        public String country_code;
+099                }
+100        
+101                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+102                public static class CleansingNumber {
+103                    
+104                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+105                        public Number sms;
+106                        
+107                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+108                        public Number call;
+109                        
+110                        /** An object containing cleansing details about a phone number. */
+111                        public static class Number {
+112                            
+113                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+114                                public String phone_number;
+115                                
+116                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+117                                public String country_code;
+118                                
+119                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+120                                public int min_length;
+121                                
+122                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int max_length;
+124                                
+125                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+126                                public int cleansed_code;
+127                        }
+128                }
+129        }
+130
+131        /**
+132         * An object containing geographical location information associated with the phone number.
+133         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+134         */
+135        public static class Location {
+136            
+137                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+138                public String county;
+139                
+140                /** A string specifying the name of the city associated with the phone number. */
+141                public String city;
+142                
+143                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+144                public String state;
+145                
+146                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+147                public String zip;
+148                
+149                /** An object containing details about the country associated with the phone number. */
+150                public Country country;
+151                
+152                /** An object containing details about the Time Zone associated with the phone number. */
+153                public TimeZone time_zone;
+154                
+155                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+156                public Coordinates coordinates;
+157                
+158                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+159                public String metro_code;
+160                
+161                /** An object containing details about the country associated with the phone number. */
+162                public static class Country {
+163                    
+164                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+165                        public String iso2;
+166                        
+167                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+168                        public String iso3;
+169                        
+170                        /** The Country Name associated with phone number. */
+171                        public String name;
+172                }
+173
+174                /** An object containing details about the Time Zone associated with the phone number. */
+175                public static class TimeZone {
+176                    
+177                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+178                        public String utc_offset_min;
+179                        
+180                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+181                        public String name;
+182                        
+183                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+184                        public String utc_offset_max;
+185                }
+186
+187                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+188                public static class Coordinates {
+189                    
+190                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+191                        public double latitude;
+192                        
+193                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+194                        public double longitude;
+195                }
+196        }
+197
+198        /** An object that describes data associated with the contact specified in the request. */
+199        public static class Contact {
+200            
+201                /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */
+202                public String firstname;
+203                
+204                /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */
+205                public String lastname;
+206                
+207                /** A string that indicates the first line of the contact’s street address. */
+208                public String address1;
+209                
+210                /** A string that indicates the second line of the contact’s street address. */
+211                public String address2;
+212                
+213                /** A string that indicates the third line of the contact’s street address. */
+214                public String address3;
+215                
+216                /** A string that indicates the fourth line of the contact’s street address. */
+217                public String address4;
+218                
+219                /** A string that indicates the city in which the contact is located. */
+220                public String city;
+221                
+222                /** A string that indicates the state, province, or region in which the contact is located. */
+223                public String state_province;
+224                
+225                /** A string that indicates the country in which the contact is located. */
+226                public String country;
+227                
+228                /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */
+229                public String zip_postal_code;
+230        }
+231
+232        /**
+233         * Converts a <strong>PhoneIdContactResponse</strong> object to its equivalent JSON format.  
+234         * @see java.lang.Object#toString()
+235         * @return A string containing the response from the TeleSign server, in JSON format.  
+236         */
+237        @Override
+238        public String toString() {
+239                Gson gson = new Gson();
+240                return gson.toJson(this);
+241        }       
+242}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Error.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Live.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Coordinates.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.Country.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.TimeZone.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Location.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.Number.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.CleansingNumber.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.OriginalNumber.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Numbering.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.PhoneType.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.Status.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.html new file mode 100644 index 0000000..7dcc1db --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdLiveResponse.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdLiveResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Live</strong> web service.  */
+015public class PhoneIdLiveResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object that contains details about the phone type. */
+029        public PhoneType phone_type;
+030
+031        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+032        public String signature_string;
+033
+034        /** An object containing details about the request status. */
+035        public Status status;
+036
+037        /** An object containing details about the numbering attributes of the specified phone number. */
+038        public Numbering numbering;
+039
+040        /** An object containing geographical location information associated with the phone number. */
+041        public Location location; 
+042        
+043        /**
+044         * A JSON object containing details about a specified phone number’s state of operation.
+045         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+046         */
+047        public Live live;
+048        
+049        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+050        public static class Error
+051        {
+052                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+053                public int code;
+054                
+055                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+056                public String description;
+057        }
+058
+059        /**  An object containing details about the phone type. */
+060        public static class PhoneType {
+061            
+062                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+063                public int code;
+064                
+065                /**  A description of the phone type. */
+066                public String description;
+067        }
+068
+069        /** An object containing details about the request status. */
+070        public static class Status {
+071                
+072                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+073                public String updated_on;
+074                
+075                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+076                public int code;
+077                
+078                /** A descriptionm of the transaction status. */
+079                public String description;
+080        }
+081
+082        /** An object containing details about the numbering attributes of the specified phone number. */
+083        public static class Numbering {
+084                
+085                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+086                public OriginalNumber original;
+087                
+088                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+089                public CleansingNumber cleansing;
+090                
+091                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+092                public static class OriginalNumber {
+093                    
+094                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+095                        public String phone_number;
+096                        
+097                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+098                        public String complete_phone_number;
+099                        
+100                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+101                        public String country_code;
+102                }
+103        
+104                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+105                public static class CleansingNumber {
+106                    
+107                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+108                        public Number sms;
+109                        
+110                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+111                        public Number call;
+112                        
+113                        /** An object containing cleansing details about a phone number. */
+114                        public static class Number {
+115                            
+116                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+117                                public String phone_number;
+118                                
+119                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+120                                public String country_code;
+121                                
+122                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+123                                public int min_length;
+124                                
+125                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+126                                public int max_length;
+127                                
+128                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+129                                public int cleansed_code;
+130                        }
+131                }
+132        }
+133
+134        /**
+135         * An object containing geographical location information associated with the phone number.
+136         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+137         */
+138        public static class Location {
+139            
+140                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+141                public String county;
+142                
+143                /** A string specifying the name of the city associated with the phone number. */
+144                public String city;
+145                
+146                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+147                public String state;
+148                
+149                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+150                public String zip;
+151                
+152                /** An object containing details about the country associated with the phone number. */
+153                public Country country;
+154                
+155                /** An object containing details about the Time Zone associated with the phone number. */
+156                public TimeZone time_zone;
+157                
+158                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+159                public Coordinates coordinates;
+160                
+161                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+162                public String metro_code;
+163                
+164                /** An object containing details about the country associated with the phone number. */
+165                public static class Country {
+166                    
+167                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+168                        public String iso2;
+169                        
+170                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+171                        public String iso3;
+172                        
+173                        /** The Country Name associated with phone number. */
+174                        public String name;
+175                }
+176
+177                /** An object containing details about the Time Zone associated with the phone number. */
+178                public static class TimeZone {
+179                    
+180                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+181                        public String utc_offset_min;
+182                        
+183                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+184                        public String name;
+185                        
+186                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+187                        public String utc_offset_max;
+188                }
+189
+190                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+191                public static class Coordinates {
+192                    
+193                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+194                        public double latitude;
+195                        
+196                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+197                        public double longitude;
+198                }
+199        }
+200
+201        /**
+202         * A JSON object containing details about a specified phone number’s state of operation.
+203         * <strong>Note:</strong> In the case where PhoneID Live is not supported for the specified phone number, the server returns a <strong>Live</strong> object that is <em>null</em>. 
+204         */
+205        public static class Live {
+206            
+207                /** A string indicating the current status of the subscriber’s phone number. */
+208                public String subscriber_status;
+209                
+210                /** A string indicating the current status of the phone equipment. */
+211                public String device_status;
+212                
+213                /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */
+214                public String roaming;
+215                
+216                /** The country in which the mobile device is roaming. */
+217                public String roaming_country;
+218        }
+219
+220        /**
+221         * Converts a <strong>PhoneIdLiveResponse</strong> object to its equivalent JSON format.  
+222         * @see java.lang.Object#toString()
+223         * @return A string containing the response from the TeleSign server, in JSON format.  
+224         */
+225        @Override
+226        public String toString() {
+227                Gson gson = new Gson();
+228                return gson.toJson(this);
+229        }
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Error.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.Number.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.CleansingNumber.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.OriginalNumber.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Numbering.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.PhoneType.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Risk.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.Status.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.html new file mode 100644 index 0000000..a6467b4 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdScoreResponse.html @@ -0,0 +1,220 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdScoreResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Score</strong> web service.  */
+015public class PhoneIdScoreResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+029        public String signature_string;
+030
+031        /** An object containing details about the request status. */
+032        public Status status;
+033
+034        /** An object containing details about the numbering attributes of the specified phone number. */
+035        public Numbering numbering;
+036
+037        /** An object that describes the risk score for the phone number specified in the request. */
+038        public Risk risk;
+039        
+040        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+041        public static class Error
+042        {
+043                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+044                public int code;
+045                
+046                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+047                public String description;
+048        }
+049
+050        /**  An object containing details about the phone type. */
+051        public static class PhoneType {
+052            
+053                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+054                public int code;
+055                
+056                /**  A description of the phone type. */
+057                public String description;
+058        }
+059
+060        /** An object containing details about the request status. */
+061        public static class Status {
+062                
+063                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+064                public String updated_on;
+065                
+066                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+067                public int code;
+068                
+069                /** A descriptionm of the transaction status. */
+070                public String description;
+071        }
+072
+073        /** An object containing details about the numbering attributes of the specified phone number. */
+074        public static class Numbering {
+075                
+076                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+077                public OriginalNumber original;
+078                
+079                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+080                public CleansingNumber cleansing;
+081                
+082                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+083                public static class OriginalNumber {
+084                    
+085                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+086                        public String phone_number;
+087                        
+088                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+089                        public String complete_phone_number;
+090                        
+091                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+092                        public String country_code;
+093                }
+094        
+095                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+096                public static class CleansingNumber {
+097                    
+098                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+099                        public Number sms;
+100                        
+101                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+102                        public Number call;
+103                        
+104                        /** An object containing cleansing details about a phone number. */
+105                        public static class Number {
+106                            
+107                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+108                                public String phone_number;
+109                                
+110                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+111                                public String country_code;
+112                                
+113                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+114                                public int min_length;
+115                                
+116                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+117                                public int max_length;
+118                                
+119                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+120                                public int cleansed_code;
+121                        }
+122                }
+123        }
+124
+125        /** An object that describes the risk score for the phone number specified in the request. */
+126        public static class Risk {
+127            
+128                /** A string indicating the severity of the risk. */
+129                public String level;
+130                
+131                /** One of the <strong>Score</strong> values. */
+132                public int score;
+133                
+134                /** A string indicating the action that TeleSign recommends that you take based on the risk score. */
+135                public String recommendation;
+136        }
+137
+138        /**
+139         * Converts a <strong>PhoneIdScoreResponse</strong> object to its equivalent JSON format.  
+140         * @see java.lang.Object#toString()
+141         * @return A string containing the response from the TeleSign server, in JSON format.  
+142         */
+143        @Override
+144        public String toString() {
+145                Gson gson = new Gson();
+146                return gson.toJson(this);
+147        }
+148}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Error.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Coordinates.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.Country.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.TimeZone.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Location.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.Number.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.CleansingNumber.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.OriginalNumber.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Numbering.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.PhoneType.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.Status.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.html b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.html new file mode 100644 index 0000000..6ef5bd9 --- /dev/null +++ b/doc/src-html/com/telesign/phoneid/response/PhoneIdStandardResponse.html @@ -0,0 +1,279 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.phoneid.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>PhoneIdStandardResponse</strong> class encapsulates all of the information returned from a call to the <strong>PhoneID Standard</strong> web service.  */
+015public class PhoneIdStandardResponse
+016{
+017        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+018        public String reference_id;
+019        
+020        /** A String containing the URI for accesses the PhoneID resource. */
+021        public String resource_uri;
+022
+023        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+024        public String sub_resource;
+025        
+026        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+027        public Error[] errors;
+028
+029        /** An object that contains details about the phone type. */
+030        public PhoneType phone_type;
+031
+032        /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/
+033        public String signature_string;
+034
+035        /** An object containing details about the request status. */
+036        public Status status;
+037
+038        /** An object containing details about the numbering attributes of the specified phone number. */
+039        public Numbering numbering;
+040
+041        /** An object containing geographical location information associated with the phone number. */
+042        public Location location; 
+043
+044        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+045        public static class Error
+046        {
+047                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+048                public int code;
+049                
+050                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+051                public String description;
+052        }
+053
+054        /**  An object containing details about the phone type. */
+055        public static class PhoneType {
+056            
+057                /** One of the <emphasis>Phone Type Codes</emphasis>." */
+058                public int code;
+059                
+060                /**  A description of the phone type. */
+061                public String description;
+062        }
+063
+064        /** An object containing details about the request status. */
+065        public static class Status {
+066                
+067                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+068                public String updated_on;
+069                
+070                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+071                public int code;
+072                
+073                /** A descriptionm of the transaction status. */
+074                public String description;
+075        }
+076
+077        /** An object containing details about the numbering attributes of the specified phone number. */
+078        public static class Numbering {
+079                
+080                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+081                public OriginalNumber original;
+082                
+083                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+084                public CleansingNumber cleansing;
+085                
+086                /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */
+087                public static class OriginalNumber {
+088                    
+089                        /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+090                        public String phone_number;
+091                        
+092                        /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */
+093                        public String complete_phone_number;
+094                        
+095                        /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+096                        public String country_code;
+097                }
+098        
+099                /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */
+100                public static class CleansingNumber {
+101                    
+102                        /** An object containing cleansing details about a phone number used for receiving text messages. */    
+103                        public Number sms;
+104                        
+105                        /** An object containing cleansing details about a phone number used for receiving voice calls. */
+106                        public Number call;
+107                        
+108                        /** An object containing cleansing details about a phone number. */
+109                        public static class Number {
+110                            
+111                                /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */
+112                                public String phone_number;
+113                                
+114                                /**  A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */
+115                                public String country_code;
+116                                
+117                                /**  The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+118                                public int min_length;
+119                                
+120                                /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */
+121                                public int max_length;
+122                                
+123                                /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */
+124                                public int cleansed_code;
+125                        }
+126                }
+127        }
+128
+129        /**
+130         * An object containing geographical location information associated with the phone number.
+131         * <strong>Note:</strong> <emphasis>Location</emphasis> refers to the place where the phone is registered, <emphasis>not</emphasis> to where it actually is at the time of this request. 
+132         */
+133        public static class Location {
+134            
+135                /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */
+136                public String county;
+137                
+138                /** A string specifying the name of the city associated with the phone number. */
+139                public String city;
+140                
+141                /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */
+142                public String state;
+143                
+144                /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */
+145                public String zip;
+146                
+147                /** An object containing details about the country associated with the phone number. */
+148                public Country country;
+149                
+150                /** An object containing details about the Time Zone associated with the phone number. */
+151                public TimeZone time_zone;
+152                
+153                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+154                public Coordinates coordinates;
+155                
+156                /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */
+157                public String metro_code;
+158                
+159                /** An object containing details about the country associated with the phone number. */
+160                public static class Country {
+161                    
+162                        /** The ISO 3166-1 2-letter Country Code associated with the phone number. */
+163                        public String iso2;
+164                        
+165                        /** The ISO 3166-1 3-letter Country Code associated with the phone number */
+166                        public String iso3;
+167                        
+168                        /** The Country Name associated with phone number. */
+169                        public String name;
+170                }
+171
+172                /** An object containing details about the Time Zone associated with the phone number. */
+173                public static class TimeZone {
+174                    
+175                        /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */
+176                        public String utc_offset_min;
+177                        
+178                        /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */
+179                        public String name;
+180                        
+181                        /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */
+182                        public String utc_offset_max;
+183                }
+184
+185                /** An object containing details about the geographical coordinates of the location where the phone number is registered. */
+186                public static class Coordinates {
+187                    
+188                        /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */
+189                        public double latitude;
+190                        
+191                        /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */
+192                        public double longitude;
+193                }
+194        }
+195
+196        /**
+197         * Converts a <strong>PhoneIdStandardResponse</strong> object to its equivalent JSON format.  
+198         * @see java.lang.Object#toString()
+199         * @return A string containing the response from the TeleSign server, in JSON format.  
+200         */
+201        @Override
+202        public String toString()
+203        {
+204                Gson gson = new Gson();
+205                return gson.toJson(this);
+206        }
+207}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/util/PhoneUtil.html b/doc/src-html/com/telesign/util/PhoneUtil.html new file mode 100644 index 0000000..6ba82d9 --- /dev/null +++ b/doc/src-html/com/telesign/util/PhoneUtil.html @@ -0,0 +1,140 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.util;
+011
+012/**
+013 * The PhoneUtil class contains a mentod for normalizing phone numbers.
+014 */
+015public class PhoneUtil
+016{
+017        /**
+018         * This mentod is a helper method for cleansing phone numbers. 
+019         * Specifically, it ensures that all phone number conform to a standard 11 digit format.
+020         * For example, (310) 555-1212 becomes 13105551212.
+021         * @param phoneNumber   [Required] A string that contains the user's phone number, in its original form. 
+022         * @return                                      The cleansed form of the phone number.
+023         */
+024        public static String formatTo11Digits(String phoneNumber)
+025        {
+026                if(phoneNumber == null) return null;
+027
+028                // Remove non-numeric characters (leaving digits 0..9). 
+029                String cleanPhone = phoneNumber.replaceAll("[^\\d]", "");
+030
+031                // Assert that the characters in the cleaned phone number are all numeric.
+032                try
+033                {
+034                        Long.parseLong(cleanPhone);             // Convert the string representation of the cleaned phone number to a long value. 
+035                }
+036                catch(NumberFormatException nfe)
+037                {
+038                        return null;
+039                }
+040
+041                switch(cleanPhone.length())
+042                {
+043                        case 0: case 1: case 2: case 3: case 4:
+044                        case 5: case 6: case 7: case 8: case 9:
+045                                return null;
+046                        case 10:                                                // Missing the dialing code for North America (+1).
+047                                return "1" + cleanPhone;
+048                        case 11:
+049                                return cleanPhone;
+050                        case 12: 
+051                                // If the phone number is 12 digits long, and begins with either "11" or "01", then treat it as country code and omit.
+052                                // For example 113102669619
+053                                if(cleanPhone.charAt(0) == '0')
+054                                {
+055                                        return cleanPhone.substring(1);         // Remove the leading zero.
+056                                } 
+057                                return null;
+058                        case 13:
+059                                if(cleanPhone.startsWith("00"))
+060                                {
+061                                        return cleanPhone.substring(2);         // Remove the leading two zeros.
+062                                }
+063                                return null;
+064                        default:
+065                                return null;
+066                }
+067        }
+068}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/util/TeleSignRequest.html b/doc/src-html/com/telesign/util/TeleSignRequest.html new file mode 100644 index 0000000..2888af3 --- /dev/null +++ b/doc/src-html/com/telesign/util/TeleSignRequest.html @@ -0,0 +1,456 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.util;
+011
+012import java.io.BufferedReader;
+013import java.io.DataOutputStream;
+014import java.io.IOException;
+015import java.io.InputStream;
+016import java.io.InputStreamReader;
+017import java.net.HttpURLConnection;
+018import java.net.URL;
+019import java.net.URLEncoder;
+020import java.security.SignatureException;
+021import java.text.SimpleDateFormat;
+022import java.util.Date;
+023import java.util.HashMap;
+024import java.util.Map;
+025import java.util.Set;
+026import java.util.TreeMap;
+027import javax.crypto.Mac;
+028import javax.crypto.spec.SecretKeySpec;
+029import org.apache.commons.codec.binary.Base64;
+030
+031/**
+032 * The TeleSignRequest class is an abstraction for creating and sending HTTP 1.1 REST Requests for TeleSign web services.  
+033 */
+034public class TeleSignRequest
+035{
+036        /** A boolean value indicates the Request Method. <em>True</em> for <strong>POST</strong>, and <em>False</em> for <strong>GET</strong>. */
+037        private boolean post;
+038                
+039        /** The Base URI. For TeleSign web services, this is https://rest.telesign.com/. */
+040        private final String base;
+041        
+042        /** The name of the network resource. Each of the TeleSign web services is identified by its resource specifier. */
+043        private final String resource;
+044        
+045        /** Your TeleSign Customer ID. This represents your TeleSign account number. */
+046        private final String customer_id;
+047        
+048        /** Your TeleSign Secret Shared Key (available from the TeleSign Client Portal). */
+049        private final String secret_key;
+050
+051        /** The set of HTTP 1.1 Request header field/value pairs. */
+052        private TreeMap<String, String> headers;
+053        
+054        /** The set of <em>TeleSign-specific</em> Request header field/value pairs. */
+055        private TreeMap<String, String> ts_headers;       
+056        
+057        /** The set of HTTP 1.1 Request parameter attribute/value pairs. */
+058        private HashMap<String, String> params;
+059
+060        /** The <em>absolute form</em> of the Resource URI */
+061        private URL url;
+062        
+063        /** The persistent session connection for the Request. */
+064        private HttpURLConnection connection;
+065        
+066        /** The contents of the entity body in the POST Request. */
+067        private String body = "";
+068        
+069        /** A boolean value that indicates whether the <em>TeleSign-specific</em> <strong>Date</strong> Request header field is used. */
+070        private boolean ts_date = false;
+071
+072        /**
+073         * The TeleSitgnRequest class constructor.
+074         * A TeleSitgnRequest object contains all of the information required to call any/all of the TeleSign web services. 
+075         * @param base          [Required] A string representing the Base URI. For TeleSign web services, this is https://rest.telesign.com/. 
+076         * @param resource              [Required] A string representing the name of the network resource. Each of the TeleSign web services is identified by its resource specifier.
+077         * @param method                [Required] A string representing the method to be performed on the resource. For TeleSign web services, this is either GET or POST. 
+078         * @param customer_id   [Required] A string representing your TeleSign Customer ID. This represents your TeleSign account number.
+079         * @param secret_key    [Required] A string representing your TeleSign Secret Shared Key (available from the TeleSign Client Portal).
+080         */
+081        public TeleSignRequest(String base, String resource, String method, String customer_id, String secret_key)
+082        {
+083                post = (method.toLowerCase().equals("post"));
+084                
+085                this.base                       = base;
+086                this.resource           = resource;
+087                this.customer_id        = customer_id;
+088                this.secret_key         = secret_key;
+089                
+090                ts_headers              = new TreeMap<String, String>();
+091                headers         = new TreeMap<String, String>();
+092                params          = new HashMap<String, String>();
+093        }
+094        
+095        /**
+096         * Adds an HTTP 1.1 Request header field/value pair to the set of Request Headers.
+097         * @param key           [Required] A string representing a Request header field <em>name</em>. 
+098         * @param value [Required] A string representing a Request header field <em>value</em>.
+099         */
+100        public void addHeader(String key, String value)
+101        {
+102                // Check to see if this request header field is a "TeleSign-specific" header field.  
+103                if((key.length() > 4) && (key.toLowerCase().substring(0, 5).equals("x-ts-")))
+104                {                       
+105                        // If using the TeleSign-specific date header, then use a blank line for the standard Date Request header.  
+106                        if(key.toLowerCase().equals("x-ts-date"))
+107                                ts_date = true;
+108                        
+109                        ts_headers.put(key, value);
+110                }
+111                
+112                headers.put(key, value);
+113        }
+114        
+115        /**
+116         * Adds an HTTP 1.1 Request parameter attribute/value pair to the set of Request Parameters.
+117         * @param key           [Required] A string representing a Request parameter attribute <em>name</em>.
+118         * @param value [Required] A string representing a Request parameter attribute <em>value</em>.
+119         */
+120        public void addParam(String key, String value)
+121        {
+122                params.put(key, value);
+123        }
+124        
+125        /**
+126         * Sets the entity body of an HTTP 1.1 POST Request message. Contains the Request parameters for <strong>Verify.call</strong> and <strong>Verify.sms</strong>.
+127         * @param post_body     [Required] A string that contains the contents of the POST Request's entity body.
+128         */
+129        public void setPostBody(String post_body)
+130        {
+131                body = post_body;
+132        }
+133        
+134        /**
+135         * Gets the entity body of an HTTP 1.1 POST Request message. Used for calls to <strong>Verify.call</strong> and <strong>Verify.sms</strong>.
+136         * @return      A string that contains the contents of the POST Request's entity body.
+137         */
+138        public String getPostBody()
+139        {
+140                return body;
+141        }
+142        
+143        /**
+144         * Returns the set of <em>TeleSign-specific</em> Request header fields.    
+145         * @return      A sorted key/value mapping that contains the TeleSign-specific Request header fields.
+146         */
+147        public Map<String, String> getTsHeaders()
+148        {
+149                return ts_headers;
+150        }
+151        
+152        /**
+153         * Returns the set of both the standard <u>and</u> the <em>TeleSign-specific</em> Request header fields.
+154         * @return      A sorted key/value mapping that contains all of the Request header fields.
+155         */
+156        public Map<String, String> getAllHeaders()
+157        {
+158                TreeMap<String, String> tmp = new TreeMap<String, String>();
+159                
+160                tmp.putAll(headers);
+161                tmp.putAll(ts_headers);
+162                
+163                return tmp;
+164        }
+165
+166        /**
+167         * Returns the set of POST Request parameters.
+168         * @return      A sorted key/value mapping that contains all of the POST Request parameters.
+169         */
+170        public Map<String, String> getAllParams()
+171        {
+172                return params;
+173        }
+174        
+175        /**
+176         * Creates and sends the REST request.
+177         * @return                      A string containing the TeleSign web server's Response.
+178         * @throws IOException  A {@link java.security.SignatureException} signals that an error occurred while attempting to sign the Request.
+179         */
+180        public String executeRequest() throws IOException
+181        {
+182                String signingString = getSigningString(customer_id); 
+183                String signature;
+184                String url_output = "";
+185                
+186                // Create the absolute form of the resource URI, and place it in a string buffer. 
+187                StringBuffer full_url = new StringBuffer(base).append(resource);
+188                
+189                if(params.size() > 0)
+190                {
+191                        full_url.append("?"); int i =0;         // The first parameter is always prefixed with a question mark.
+192                        
+193                        for(String key : params.keySet())
+194                        {
+195                                if(++i != 0)                            // Additonal parameters are always prefixed with an ampersands.
+196                                        full_url.append("&"); 
+197                                
+198                                full_url.append(URLEncoder.encode(key, "UTF-8")).append("=").append(URLEncoder.encode(params.get(key), "UTF-8"));
+199                        }
+200                }
+201                
+202                /* Convert the URL string into a URL object,
+203                 * to use later for creating a 
+204                 * persistent connection for the session.
+205                 */
+206                url = new URL(full_url.toString());             
+207                
+208                /* Create the Signature using the formula:
+209                 * Signature = Base64( HMAC-SHA1( YourTeleSignAPIKey, UTF-8-Encoding-Of( StringToSign ) ) 
+210                 */
+211                try
+212                {
+213                        signature = hmacsha1(signingString, secret_key);
+214                }
+215                catch (SignatureException e)
+216                {
+217                        System.err.println("Error signing request " + e.getMessage());
+218                        
+219                        return null;
+220                }
+221                
+222                /* Create the Authorization header using the following formula:
+223                 * Authorization = "TSA" + " " + Customer ID + ":" + Signature.
+224                 */
+225                String auth_header = "TSA" + customer_id + ":" + signature;
+226                
+227                /* Create an HTTP Connection object to
+228                 * open a persistent connection to the URL, 
+229                 * and begin a new session for the Request/Response transaction. 
+230                 */
+231                connection = (HttpURLConnection) url.openConnection();          
+232                connection.setConnectTimeout(30000);
+233
+234                // Send the Request message headers to the web resource.
+235                connection.setRequestProperty("Authorization", auth_header);    // Send the Authorization header.
+236                
+237                if(post)                                                                                                                        // This Request message contains an enitiy body, so
+238                        connection.setRequestProperty("Content-Length", Integer.toString(body.length()));       // Send the size of the message payload as
+239                                                                                                                                                // the value of the Content-Length header.  
+240                for(String key : ts_headers.keySet())
+241                        connection.setRequestProperty(key, ts_headers.get(key));        // Add the TeleSign-specific Request headers.
+242
+243                for(String key : headers.keySet())
+244                        connection.setRequestProperty(key, headers.get(key));           // Add the generl Request headers.
+245                
+246                if(post)                                                                        // This Request message contains an enitiy body, so
+247                {                                                                               // use the connection for outputting (writing a stream of) information,
+248                    connection.setDoOutput(true);                               // as opposed to false, for inputting.
+249                    
+250                    DataOutputStream wr = new DataOutputStream (connection.getOutputStream ());
+251                    
+252                    wr.writeBytes(body);                                                // Write the entity body for the POST Request.
+253                    wr.flush(); wr.close();
+254                }
+255                
+256                // Sending Request now complete. 
+257                
+258                
+259                // Retrieve the Status Code from the web server.                   The Status-Code is a 3-digit integer that indicates the result
+260                int response = connection.getResponseCode();            // of the web server's attempt to understand and satisfy your request.          
+261                
+262                // Retrieve the contents of the Response message from the TeleSign server.
+263                BufferedReader in;
+264                
+265                try
+266                {
+267                    // Extract the the contents of the Response message with a stream object.
+268                    InputStream  isr = (response == 200) ? connection.getInputStream() : connection.getErrorStream();   // When successful, the value is "200".
+269                        
+270                        in = new BufferedReader(new InputStreamReader(isr));    // Read the input stream into a buffer.
+271                        
+272                        String urlReturn;                                               // Transfer the contents of the buffer to string variable.
+273        
+274                        while ((urlReturn = in.readLine()) != null)             // The response headers are separated using the new line character ("\n").
+275                            url_output += urlReturn;                                    // Information returned in the response body is structured in JSON format.
+276                        
+277                        in.close();                     
+278                }
+279                catch (IOException e)
+280                {
+281                        System.err.println("IOException while reading from input stream " + e.getMessage());
+282                }               
+283                
+284                return url_output;
+285        }
+286        
+287        /**
+288         * Create the <em>string to sign</em>.
+289         * This is a <em>helper method</em>, used interanlly by the {@link com.telesign.util.TeleSignRequest#executeRequest()} method.
+290         * @param customer_id   [Required] A string representing your TeleSign Customer ID. This represents your TeleSign account number.
+291         * @return                                      A string representing the signing string used to create a Signature object, for the authenticate the REST request.  
+292         */
+293        private String getSigningString(String customer_id)
+294        {
+295                // Create the stringToSign element of the Signature component.
+296                String stringToSign = post ? "POST\n": "GET\n";
+297                String content_type = post ? "application/x-www-form-urlencoded\n" : "\n";
+298
+299                // Concatonate the Request headers to the stringToSign. 
+300                stringToSign += content_type;
+301                
+302                /* Add the Date header to both the set of Headers,
+303                /* and to the stringToSign (killing two birds with one stone).
+304                 */
+305                if(ts_date)                                     // If you use the TeleSign-specific Date header, 
+306                        stringToSign += "\n";           // then the standard Date header isn't required,
+307                else                                            // so just insert an empty line into the StringToSign (as a placeholder).
+308                {
+309                        // Create a standard HTTP 1.1 Date header field.
+310                        Date now = new Date();
+311                        
+312                        /* Convert the Date object to conform to the RFC 2616, Section 3.3.1 format.
+313                         * For example : Tue, 10 Jan 2012 19:36:42 +0000. 
+314                         */
+315                        SimpleDateFormat rfc2616 = new SimpleDateFormat("EEE, dd MMM YYYY HH:mm:ss ZZZZ");                      
+316                        String date = rfc2616.format(now);
+317                        addHeader("Date", date);
+318                        
+319                        stringToSign += date + "\n";
+320                }
+321                
+322                /* Create the CanonicalizedTsHeaders element. This entails:
+323                 * Converting header names to lowercase,
+324                 * Sorting the set by header name,
+325                 * Ensuring that each X-TS- header name appears just once,
+326                 * Unfolding long header values that span multiple lines, by replacing the folding white space (newline) with a single space, and
+327                 * Removing white space surrounding the colon that appears between each header name/value pair.
+328                 */
+329                Set<String> orderedKeys = ts_headers.keySet();
+330                
+331                for(String key : orderedKeys)                                                                   // Add each of the X-TS- headers (name:value pairs) to the stringToSign,
+332                        stringToSign += key.toLowerCase() + ":" + ts_headers.get(key) + "\n";   // each one separated by a newline.
+333                
+334                // Create the CanonicalizedPOSTVariables element.
+335                if(post)
+336                        stringToSign += body + "\n";                    // Just concatonate the POST Request entity body "as-is" to the stringToSign.
+337                
+338                // Create the CanonicalizedResource element. 
+339                stringToSign += resource;                                       // Just concatonate the resource "as-is" to the stringToSign.
+340                
+341                return stringToSign;
+342        }
+343        
+344        /**
+345         * Creates the Signature component for the Authorization header field. Uses your Secret Key to encode the stringToSign.   
+346         * This is a <em>helper method</em>, used interanlly by the {@link TeleSignRequest#executeRequest()} method.
+347         * @param data  [Required] The stringToSign.  
+348         * @param key           [Required] Your TeleSign API Key. Also known as your Secret Key, and your Shared Cryptographic Key. It s a bese64-encoded string value.
+349         * @return              A String containing the Base64-encoded hash-based message authentication code.
+350         * @throws java.security.SignatureException     Failed to generate HMAC. IllegalArgumentException - if algorithm is null or key is null or empty.
+351         */
+352        private String hmacsha1(String data, String key)  throws java.security.SignatureException
+353        {
+354                String HMAC_SHA1_ALGORITHM = "HmacSHA1";
+355                String result;
+356                
+357                byte[] decoded_key = Base64.decodeBase64(key);  // Get the raw key value.
+358                
+359                try
+360                {
+361                        /* Construct a another secret key from the raw key, 
+362                         * one that can be used with the specified cryptographic hash algorithm. 
+363                         */
+364                        SecretKeySpec signingKey = new SecretKeySpec(decoded_key, HMAC_SHA1_ALGORITHM);
+365                        
+366                        // Create a MAC object, which implements the SHA-1 hash algorithm.
+367                        Mac mac = Mac.getInstance(HMAC_SHA1_ALGORITHM);
+368                        mac.init(signingKey);                                                           //  Use the new encryption key to for encrypting the stringToSign.
+369                        
+370                        // Encrypt the stringToSign.
+371                        byte[] rawHmac = mac.doFinal(data.getBytes());                  // This renders the encrypted for of the stringToSign as chunk of binary data.
+372                        
+373                        // Encode the binary data into an ASCII string format - so it can be sent reliably over the Internet (a medium originally designed for transporting textual data). 
+374                        result =  new String(Base64.encodeBase64(rawHmac));
+375                        
+376                }
+377                catch (Exception e)
+378                {
+379                        throw new SignatureException("Failed to generate HMAC : " + e.getMessage());
+380                }
+381                
+382                return result;
+383        }
+384}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/verify/Verify.html b/doc/src-html/com/telesign/verify/Verify.html new file mode 100644 index 0000000..5b328b9 --- /dev/null +++ b/doc/src-html/com/telesign/verify/Verify.html @@ -0,0 +1,302 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.verify;
+011
+012import com.google.gson.Gson;
+013import com.telesign.util.PhoneUtil;
+014import com.telesign.util.TeleSignRequest;
+015import com.telesign.verify.response.VerifyResponse;
+016import java.io.IOException;
+017import java.net.URLEncoder;
+018
+019/**
+020 *  The Verify class abstracts your interactions with the <em>TeleSign Verify web service</em>.
+021 *  A Verify object encapsulates your credentials (your TeleSign <em>Customer ID</em> and <em>Secret Key</em>).
+022 */
+023public class Verify
+024{
+025        /**
+026         * The Verify class constructor.
+027         * Once you instantiate a Verify object, you can use it to make instance calls to <em>Verify SMS</em> and <em>Verify Call</em>.
+028         * @param customer_id   [Required]      A string representing your TeleSign Customer ID (your TeleSign account number).
+029         * @param secret_key    [Required]      A string representing your TeleSign Secret Key (a bese64-encoded string valu, available from the TeleSign Client Portal).
+030         */
+031        public Verify(String customer_id, String secret_key)
+032        {
+033                this.customer_id = customer_id;
+034                this.secret_key = secret_key;
+035        }
+036        
+037        /**
+038         * Delivers a verification code to the end user by sending it in a text message.
+039         * This is the simplest of the three overloads of this method. This overload takes the only required paramter—the end user's phone number. 
+040         * @param identifier    [Required]      A string representing the user’s phone number.
+041         * @return                              A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+042         */
+043        public VerifyResponse sms(String identifier)
+044        {
+045                return sms(identifier, null, null, null);
+046        }
+047        
+048        /**
+049         *  Delivers a verification code to the end user by sending it in a text message.
+050         *  Use this overload when the end user's written language isn't the default language (English).
+051         * @param identifier    [Required]      A string representing the user’s phone number.
+052         * @param language      [Optional]      A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
+053         * @return                              A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+054         */
+055        public VerifyResponse sms(String identifier, String language)
+056        {
+057                return sms(identifier, language, null, null);
+058        }
+059        
+060        /**
+061         * Delivers a verification code to the end user by sending it in a text message.
+062         * Use this overload when the end user's written language isn't the default language (English), or when you want to send them a verification code that you create, or when you want to apply a custom text message template.  
+063         * @param identifier            [Required]      A string representing the user’s phone number.
+064         * @param language              [Optional]      A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
+065         * @param verify_code   [Optional]      A string representing the verification code that you want to send to the end user. TeleSign will automatically generate a verification code for you if to set this value to null.
+066         * @param template              [Optional]      A string representing a text message to override the predefined text message template. Your text message must incorporate a $$CODE$$ placeholder to integrate the verify_code field. Set this value to null (the default) to use the predefined template.
+067         * @return                                      A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+068         */
+069        public VerifyResponse sms(String identifier, String language, String verify_code, String template)
+070        {
+071                String result = null;
+072                
+073                try
+074                {
+075                        String clean_phone = PhoneUtil.formatTo11Digits(identifier);
+076                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/sms", "POST", customer_id, secret_key);                       
+077                        String body = "phone_number=" + URLEncoder.encode(clean_phone, "UTF-8");
+078                        
+079                        if(language != null)
+080                        {
+081                                body += "&language=" + URLEncoder.encode(language, "UTF-8");
+082                        }
+083                        
+084                        if(verify_code != null)
+085                        {
+086                                body += "&verify_code=" + URLEncoder.encode(verify_code, "UTF-8");
+087                        }
+088                        
+089                        if(template != null)
+090                        {
+091                                body += "&template=" + URLEncoder.encode(template, "UTF-8");
+092                        }
+093                        
+094                        tr.setPostBody(body);
+095                        
+096                        result = tr.executeRequest();
+097                        
+098                }
+099                catch (IOException e)
+100                {
+101                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+102                }
+103                
+104                Gson gson = new Gson();
+105                VerifyResponse response = gson.fromJson(result, VerifyResponse.class);
+106                
+107                return response;                
+108        }
+109        
+110        /**
+111         * Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code.
+112         * This is the simplest of the three overloads of this method. This overload takes the only required paramter—the end user's phone number.
+113         * @param phone_number  [Required]      A string representing the user’s phone number.
+114         * @return                                      A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+115         */
+116        public VerifyResponse call(String phone_number)
+117        {
+118                return call(phone_number, null, null, null, 0, null, true);
+119        }
+120        
+121        /**
+122         * Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code.
+123         * Use this overload when the end user's spoken language isn't the default language (English).
+124         * @param phone_number  [Required] A string representing the user’s phone number.
+125         * @param language              [Required] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default). 
+126         * @return                      A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+127         */
+128        public VerifyResponse call(String phone_number, String language)
+129        {
+130                return call(phone_number, language, null, null, 0, null, true);
+131        }
+132        
+133        /**
+134         * Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code.
+135         * Use this overload when the end user's written language isn't the default language (English), or when you want to send them a verification code that you create, or when you need to specify a method for handling automated interactions with a PBX .
+136         * @param phone_number          [Required]      A string representing the user’s phone number.
+137         * @param language                      [Required] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default).
+138         * @param verify_code           [Optional]      A string representing the verification code that you want to send to the end user. TeleSign will automatically generate a verification code for you if to set this value to null.
+139         * @param verify_method         [Optional]      A string representing the input method you want the end user to use when returning the verification code. Use a value of "keypress" when you want the user to use their phone to dial the code. Set this value to null when you want the user to enter the code into your web aplication (the default). 
+140         * @param extension_type                [Optional]      An Integer value representing the type of response to use when dialing into a Private Branch Exchange (PBX). Use a value of 1 to have TeleSign use Dual-Tone Multi-Frequency (DTMF) tones to dail the user's extension. Use a value of 2 to have TeleSign use voice automation to request the user's extension. Use a value of 0 (the default) when the user isn't behind a PBX. 
+141         * @param extension_template    [Optional]      A numerical string specifying the user's PBX extension number. Since this value is used in the callstring, you can include one second pauses by adding commas before the extension number.  Set this value to null (the default) if not used. 
+142         * @param redial                        [Optional]      A boolean value that enables/disables redialing. Set this value to "true" (the default) when you want TeleSign to reattempt the call after a failed attempt. Set this value to "false" when you don't.
+143         * @return                                              A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+144         */
+145        public VerifyResponse call(String phone_number, String language, String verify_code, String verify_method, int extension_type, String extension_template, boolean redial)
+146        {
+147                String result = null;
+148                
+149                try
+150                {
+151                        String clean_phone = PhoneUtil.formatTo11Digits(phone_number);
+152                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/call", "POST", customer_id, secret_key);                      
+153                        String body = "phone_number=" + URLEncoder.encode(clean_phone, "UTF-8");
+154                        
+155                        if(language != null)
+156                        {
+157                                body += "&language=" + URLEncoder.encode(language, "UTF-8");
+158                        }
+159                        
+160                        if(verify_code != null)
+161                        {
+162                                body += "&verify_code=" + URLEncoder.encode(verify_code, "UTF-8");
+163                        }
+164                        
+165                        if(verify_method != null && verify_method.equalsIgnoreCase("keypress"))
+166                        {
+167                                body += "&verify_method=" + URLEncoder.encode(verify_method, "UTF-8");
+168                        }
+169                        
+170                        if(extension_type > 0 && extension_type < 3)
+171                        {
+172                                body += "&extension_type=" + URLEncoder.encode(Integer.toString(extension_type), "UTF-8");
+173                        }
+174                        
+175                        if(extension_template != null)
+176                        {
+177                                body += "&extension_template=" + URLEncoder.encode(extension_template, "UTF-8");
+178                        }
+179                        
+180                        if(!redial)     // Set this only if it is false.
+181                        {
+182                                body += "&redial=" + URLEncoder.encode(Boolean.toString(redial), "UTF-8");
+183                        }                       
+184                        
+185                        tr.setPostBody(body);
+186                        
+187                        result = tr.executeRequest();
+188                        
+189                } 
+190                catch (IOException e)
+191                {
+192                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+193                }
+194                
+195                Gson gson = new Gson();
+196                VerifyResponse response = gson.fromJson(result, VerifyResponse.class);
+197                
+198                return response;
+199        }
+200        
+201        /**
+202         * Retrieves the status of a phone verification (for either SMS or Call).
+203         * Call this method as a follow-up, after sending a verification code to an end user.
+204         * This method takes only one paramter—the reference identifier that you received from TeleSign after calling either {@link com.telesign.verify#sms()} or {@link com.telesign.verify#call()}.   
+205         * @param resource_id   [Required]      The string value that uniquely identifies a Phone Verify service transaction. Each time you make a Phone Verify call, the TeleSign server responds with this auto-generated value.
+206         * @return                                      A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server.
+207         */
+208        public VerifyResponse status(String resource_id)
+209        {
+210                String result = null;
+211                
+212                try
+213                {
+214                        TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/" + resource_id, "GET", customer_id, secret_key);
+215                        result = tr.executeRequest();
+216                }
+217                catch (IOException e)
+218                {
+219                        System.err.println("IOException while executing phoneid API: " + e.getMessage());
+220                }
+221                
+222                Gson gson = new Gson();
+223                VerifyResponse response = gson.fromJson(result, VerifyResponse.class);
+224                
+225                return response;
+226        }       
+227        
+228        private final String customer_id;
+229        private final String secret_key;
+230}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/verify/response/VerifyResponse.Error.html b/doc/src-html/com/telesign/verify/response/VerifyResponse.Error.html new file mode 100644 index 0000000..57952f5 --- /dev/null +++ b/doc/src-html/com/telesign/verify/response/VerifyResponse.Error.html @@ -0,0 +1,149 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.verify.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>VerifyResponse</strong> class encapsulates all of the information returned from a call to either the <strong>Verify SMS</strong> web service, or to the <strong>Verify Call</strong>  web service. */
+015public class VerifyResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object containing details about the request status. */
+029        public Status status;
+030
+031        /** An object that describes the verification status. */
+032        public Verify verify;
+033        
+034        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+035        public static class Error
+036        {
+037                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+038                public int code;
+039                
+040                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+041                public String description;
+042        }
+043
+044        /** An object containing details about the request status. */
+045        public static class Status {
+046                
+047                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+048                public String updated_on;
+049                
+050                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+051                public int code;
+052                
+053                /** A descriptionm of the transaction status. */
+054                public String description;
+055        }
+056
+057        /** An object that describes the verification status. */
+058        public static class Verify {
+059            
+060                /** Indicates whether the verification code entered matches that which was sent. Possible values are VALID, INVALID, or UNKNOWN. When the code entered matches the code sent, the response will be VALID. When the code entered does not match the code sent, code_state will be INVALID. */
+061                public String code_state;
+062                
+063                /**  Always set to an empty string. */
+064                public String code_entered;
+065        }
+066
+067        /**
+068         * Converts a <strong>VerifyResponse</strong> object to its equivalent JSON format.  
+069         * @see java.lang.Object#toString()
+070         * @return A string containing the response from the TeleSign server, in JSON format.  
+071         */
+072        @Override
+073        public String toString() {
+074                Gson gson = new Gson();
+075                return gson.toJson(this);
+076        }
+077}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/verify/response/VerifyResponse.Status.html b/doc/src-html/com/telesign/verify/response/VerifyResponse.Status.html new file mode 100644 index 0000000..57952f5 --- /dev/null +++ b/doc/src-html/com/telesign/verify/response/VerifyResponse.Status.html @@ -0,0 +1,149 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.verify.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>VerifyResponse</strong> class encapsulates all of the information returned from a call to either the <strong>Verify SMS</strong> web service, or to the <strong>Verify Call</strong>  web service. */
+015public class VerifyResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object containing details about the request status. */
+029        public Status status;
+030
+031        /** An object that describes the verification status. */
+032        public Verify verify;
+033        
+034        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+035        public static class Error
+036        {
+037                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+038                public int code;
+039                
+040                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+041                public String description;
+042        }
+043
+044        /** An object containing details about the request status. */
+045        public static class Status {
+046                
+047                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+048                public String updated_on;
+049                
+050                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+051                public int code;
+052                
+053                /** A descriptionm of the transaction status. */
+054                public String description;
+055        }
+056
+057        /** An object that describes the verification status. */
+058        public static class Verify {
+059            
+060                /** Indicates whether the verification code entered matches that which was sent. Possible values are VALID, INVALID, or UNKNOWN. When the code entered matches the code sent, the response will be VALID. When the code entered does not match the code sent, code_state will be INVALID. */
+061                public String code_state;
+062                
+063                /**  Always set to an empty string. */
+064                public String code_entered;
+065        }
+066
+067        /**
+068         * Converts a <strong>VerifyResponse</strong> object to its equivalent JSON format.  
+069         * @see java.lang.Object#toString()
+070         * @return A string containing the response from the TeleSign server, in JSON format.  
+071         */
+072        @Override
+073        public String toString() {
+074                Gson gson = new Gson();
+075                return gson.toJson(this);
+076        }
+077}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/verify/response/VerifyResponse.Verify.html b/doc/src-html/com/telesign/verify/response/VerifyResponse.Verify.html new file mode 100644 index 0000000..57952f5 --- /dev/null +++ b/doc/src-html/com/telesign/verify/response/VerifyResponse.Verify.html @@ -0,0 +1,149 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.verify.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>VerifyResponse</strong> class encapsulates all of the information returned from a call to either the <strong>Verify SMS</strong> web service, or to the <strong>Verify Call</strong>  web service. */
+015public class VerifyResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object containing details about the request status. */
+029        public Status status;
+030
+031        /** An object that describes the verification status. */
+032        public Verify verify;
+033        
+034        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+035        public static class Error
+036        {
+037                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+038                public int code;
+039                
+040                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+041                public String description;
+042        }
+043
+044        /** An object containing details about the request status. */
+045        public static class Status {
+046                
+047                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+048                public String updated_on;
+049                
+050                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+051                public int code;
+052                
+053                /** A descriptionm of the transaction status. */
+054                public String description;
+055        }
+056
+057        /** An object that describes the verification status. */
+058        public static class Verify {
+059            
+060                /** Indicates whether the verification code entered matches that which was sent. Possible values are VALID, INVALID, or UNKNOWN. When the code entered matches the code sent, the response will be VALID. When the code entered does not match the code sent, code_state will be INVALID. */
+061                public String code_state;
+062                
+063                /**  Always set to an empty string. */
+064                public String code_entered;
+065        }
+066
+067        /**
+068         * Converts a <strong>VerifyResponse</strong> object to its equivalent JSON format.  
+069         * @see java.lang.Object#toString()
+070         * @return A string containing the response from the TeleSign server, in JSON format.  
+071         */
+072        @Override
+073        public String toString() {
+074                Gson gson = new Gson();
+075                return gson.toJson(this);
+076        }
+077}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/doc/src-html/com/telesign/verify/response/VerifyResponse.html b/doc/src-html/com/telesign/verify/response/VerifyResponse.html new file mode 100644 index 0000000..57952f5 --- /dev/null +++ b/doc/src-html/com/telesign/verify/response/VerifyResponse.html @@ -0,0 +1,149 @@ + + + +Source code + + + +
      +
      001/**
+002 * @version             1.0
+003 * @copyright           Copyright © 2013, TeleSign Corporation.
+004 * @license             http://opensource.org/licenses/mit-license.php The MIT License (MIT).
+005 * @author              J. Weatherford
+006 * @maintainer          Humberto Morales
+007 * @repository          https://github.com/TeleSign/java_telesign
+008 * @support             support@telesign.com
+009 */
+010package com.telesign.verify.response;
+011
+012import com.google.gson.Gson;
+013
+014/** The <strong>VerifyResponse</strong> class encapsulates all of the information returned from a call to either the <strong>Verify SMS</strong> web service, or to the <strong>Verify Call</strong>  web service. */
+015public class VerifyResponse {
+016        /** A String containing a <em>reference identifier</em> that uniquely identifies the Request message that initiated this Response. */
+017        public String reference_id;
+018        
+019        /** A String containing the URI for accesses the PhoneID resource. */
+020        public String resource_uri;
+021
+022        /** A String containing the name of the subresource that was accessed. For example, "standard". */
+023        public String sub_resource;
+024        
+025        /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */    
+026        public Error[] errors;
+027
+028        /** An object containing details about the request status. */
+029        public Status status;
+030
+031        /** An object that describes the verification status. */
+032        public Verify verify;
+033        
+034        /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */
+035        public static class Error
+036        {
+037                /**  A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */
+038                public int code;
+039                
+040                /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */
+041                public String description;
+042        }
+043
+044        /** An object containing details about the request status. */
+045        public static class Status {
+046                
+047                /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */
+048                public String updated_on;
+049                
+050                /**  One of the<emphasis> Transaction Status Codes</emphasis>. */
+051                public int code;
+052                
+053                /** A descriptionm of the transaction status. */
+054                public String description;
+055        }
+056
+057        /** An object that describes the verification status. */
+058        public static class Verify {
+059            
+060                /** Indicates whether the verification code entered matches that which was sent. Possible values are VALID, INVALID, or UNKNOWN. When the code entered matches the code sent, the response will be VALID. When the code entered does not match the code sent, code_state will be INVALID. */
+061                public String code_state;
+062                
+063                /**  Always set to an empty string. */
+064                public String code_entered;
+065        }
+066
+067        /**
+068         * Converts a <strong>VerifyResponse</strong> object to its equivalent JSON format.  
+069         * @see java.lang.Object#toString()
+070         * @return A string containing the response from the TeleSign server, in JSON format.  
+071         */
+072        @Override
+073        public String toString() {
+074                Gson gson = new Gson();
+075                return gson.toJson(this);
+076        }
+077}
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
      +
      + + diff --git a/overview.html b/overview.html new file mode 100644 index 0000000..8266ab2 --- /dev/null +++ b/overview.html @@ -0,0 +1,10 @@ + + + +

      + The TeleSign Java SDK is a Java™ component that provides an interface to TeleSign Web Services. + It contains a Java class library that presents our web services in an intuitive, hierarchical object model, + so you can create and manipulate them in the way you're accustomed. + You can use this SDK to build TeleSign-based web applications in Java code, as MVC 3 web applications, using the Eclipse or NetBeans IDEs.

      + + \ No newline at end of file diff --git a/src/com/telesign/phoneid/PhoneId.java b/src/com/telesign/phoneid/PhoneId.java index f5d991b..a51e8a0 100644 --- a/src/com/telesign/phoneid/PhoneId.java +++ b/src/com/telesign/phoneid/PhoneId.java @@ -1,7 +1,14 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.phoneid; -import java.io.IOException; - import com.google.gson.Gson; import com.telesign.phoneid.response.PhoneIdContactResponse; import com.telesign.phoneid.response.PhoneIdLiveResponse; @@ -9,51 +16,43 @@ import com.telesign.phoneid.response.PhoneIdStandardResponse; import com.telesign.util.PhoneUtil; import com.telesign.util.TeleSignRequest; - - +import java.io.IOException; /** - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford + * The PhoneId class abstracts your interactions with the TeleSign PhoneID web service. + * A PhoneId object encapsulates your credentials (your TeleSign Customer ID and Secret Key). */ -public class PhoneId { - +public class PhoneId +{ /** - * Implementation of the TeleSign PhoneId api - * - *

      - * https://portal.telesign.com/docs/content/phoneid.html - * - * Simple constructor for setting the customer id and secret_key - * @param customer_id the TeleSign customer id. - * @param secret_key the TeleSign secret key + * The PhoneId class constructor. + * Once you instantiate a PhoneId object, you can use it to make instance calls to PhoneID Standard, PhoneID Score, PhoneID Contact, and PhoneID Live. + * @param customer_id [Required] A string representing your TeleSign Customer ID. This represents your TeleSign account number. + * @param secret_key [Required] A string representing your TeleSign Secret Key (available from the TeleSign Client Portal). */ - public PhoneId(String customer_id, String secret_key) { - this.customer_id = customer_id; - this.secret_key = secret_key; + public PhoneId(String customer_id, String secret_key) + { + this.customer_id = customer_id; + this.secret_key = secret_key; } /** - * Make a phoneid standard request to Telesign's public API. Requires the - * phone number. The method creates a @see TeleSignRequest for the standard - * api, signs it using the standard SHA1 hash, and performs a GET request. - * - *

      - * https://portal.telesign.com/docs/content/phoneid-live.html - * - * @param identifier a US phone number to make the standard request against. - * @return {@link com.telesign.phoneid.response.PhoneIdStandardResponse PhoneIdStandardResponse} The fully formed response object. If an error occured, the - * error array of the response will be set + * Returns information about a specified phone number’s type, numbering structure, cleansing details, and location details. + * @param identifier [Required] A string representing the phone number you want information about. + * @return A {@link com.telesign.phoneid.response.PhoneIdStandardResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public PhoneIdStandardResponse standard(String identifier) { + public PhoneIdStandardResponse standard(String identifier) + { String result = null; - try { + + try + { String clean_phone = PhoneUtil.formatTo11Digits(identifier); TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/phoneid/standard/" + clean_phone, "GET", customer_id, secret_key); result = tr.executeRequest(); - } catch (IOException e) { + } + catch (IOException e) + { System.err.println("IOException while executing phoneid API: " + e.getMessage()); } @@ -64,29 +63,24 @@ public PhoneIdStandardResponse standard(String identifier) { } /** - * Make a phoneid score request to TeleSign's public API. Requires the - * phone number and a string representing the use case code. The method - * creates a {@link com.telesign.util.TeleSignRequest TeleSignRequest} for the score api, signs it using - * the standard SHA1 hash, and performs a GET request. - * - *

      - * https://portal.telesign.com/docs/content/phoneid-live.html - *

      - * - * https://portal.telesign.com/docs/content/phoneid-live.html - *

      - * - * https://portal.telesign.com/docs/content/phoneid-live.html - *

      - * + + +

      + Contains the PhoneId class, which abstracts calls to the TeleSign PhoneID Web Service. +

      +

      + The PhoneID web service retrieves information about a specified phone number. This includes the it's: +

      +
        +
      • Type,
        • +
      • Numbering Structure,
        • +
      • Cleansing Details, and
        • +
      • Location.
        • +
      +

      + Using this service, you can decide what types of phone numbers to accept from users, + or determine whether the numbers that users submit coincide with the address information provided. +

      + + \ No newline at end of file diff --git a/src/com/telesign/phoneid/response/PhoneIdContactResponse.java b/src/com/telesign/phoneid/response/PhoneIdContactResponse.java index fa674c0..c220ddf 100644 --- a/src/com/telesign/phoneid/response/PhoneIdContactResponse.java +++ b/src/com/telesign/phoneid/response/PhoneIdContactResponse.java @@ -1,113 +1,243 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.phoneid.response; import com.google.gson.Gson; - -/** - * Google GSON mapped class to represent a TeleSign JSON response to a - * PhoneId.contact() request - * - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford - */ +/** The PhoneIdContactResponse class encapsulates all of the information returned from a call to the PhoneID Contact web service. */ public class PhoneIdContactResponse { + /** A String containing a reference identifier that uniquely identifies the Request message that initiated this Response. */ public String reference_id; + + /** A String containing the URI for accesses the PhoneID resource. */ public String resource_uri; + + /** A String containing the name of the subresource that was accessed. For example, "standard". */ public String sub_resource; + + /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */ public Error[] errors; + + /** An object that contains details about the phone type. */ public PhoneType phone_type; + + /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/ public String signature_string; + + /** An object containing details about the request status. */ public Status status; + + /** An object containing details about the numbering attributes of the specified phone number. */ public Numbering numbering; + + /** An object containing geographical location information associated with the phone number. */ public Location location; + + /** An object that describes data associated with the contact specified in the request. */ public Contact contact; - public static class Error { + /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */ + public static class Error + { + /** A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */ public int code; + + /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */ public String description; } - + + /** An object containing details about the phone type. */ public static class PhoneType { + + /** One of the Phone Type Codes." */ public int code; + + /** A description of the phone type. */ public String description; } - + + /** An object containing details about the request status. */ public static class Status { + + /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */ public String updated_on; + + /** One of the Transaction Status Codes. */ public int code; + + /** A descriptionm of the transaction status. */ public String description; } - + + /** An object containing details about the numbering attributes of the specified phone number. */ public static class Numbering { + + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public OriginalNumber original; + + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public CleansingNumber cleansing; + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public static class OriginalNumber { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */ public String complete_phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; } + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public static class CleansingNumber { + + /** An object containing cleansing details about a phone number used for receiving text messages. */ public Number sms; + + /** An object containing cleansing details about a phone number used for receiving voice calls. */ public Number call; + + /** An object containing cleansing details about a phone number. */ public static class Number { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; + + /** The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int min_length; + + /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int max_length; + + /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */ public int cleansed_code; } } } - + + /** + * An object containing geographical location information associated with the phone number. + * Note: Location refers to the place where the phone is registered, not to where it actually is at the time of this request. + */ public static class Location { + + /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */ public String county; + + /** A string specifying the name of the city associated with the phone number. */ public String city; + + /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */ public String state; + + /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */ public String zip; + + /** An object containing details about the country associated with the phone number. */ public Country country; + + /** An object containing details about the Time Zone associated with the phone number. */ public TimeZone time_zone; + + /** An object containing details about the geographical coordinates of the location where the phone number is registered. */ public Coordinates coordinates; + + /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */ public String metro_code; + /** An object containing details about the country associated with the phone number. */ public static class Country { + + /** The ISO 3166-1 2-letter Country Code associated with the phone number. */ public String iso2; + + /** The ISO 3166-1 3-letter Country Code associated with the phone number */ public String iso3; + + /** The Country Name associated with phone number. */ public String name; } - + + /** An object containing details about the Time Zone associated with the phone number. */ public static class TimeZone { + + /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */ public String utc_offset_min; + + /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */ public String name; + + /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */ public String utc_offset_max; } - + + /** An object containing details about the geographical coordinates of the location where the phone number is registered. */ public static class Coordinates { + + /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */ public double latitude; + + /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */ public double longitude; } } - + + /** An object that describes data associated with the contact specified in the request. */ public static class Contact { + + /** A string that indicates the contact’s first name or given name. If the result is a business name, the full business name goes in this field. Depending on the data provider, it might or might not be possible to distinguish business names from personal names. */ public String firstname; + + /** A string that indicates the contact’s last name or family name. If that contact is a business, this value is null. */ public String lastname; + + /** A string that indicates the first line of the contact’s street address. */ public String address1; + + /** A string that indicates the second line of the contact’s street address. */ public String address2; + + /** A string that indicates the third line of the contact’s street address. */ public String address3; + + /** A string that indicates the fourth line of the contact’s street address. */ public String address4; + + /** A string that indicates the city in which the contact is located. */ public String city; + + /** A string that indicates the state, province, or region in which the contact is located. */ public String state_province; + + /** A string that indicates the country in which the contact is located. */ public String country; + + /** A string that indicates the United States Postal Service ZIP Code in which the contact is located (US addresses only). */ public String zip_postal_code; } - + + /** + * Converts a PhoneIdContactResponse object to its equivalent JSON format, using the {@link com.google.gson.Gson} class library. + * @see java.lang.Object#toString() + * @return A string containing the response from the TeleSign server, in JSON format. + * @see com.google.gson.Gson + */ @Override public String toString() { Gson gson = new Gson(); return gson.toJson(this); - } - + } } \ No newline at end of file diff --git a/src/com/telesign/phoneid/response/PhoneIdLiveResponse.java b/src/com/telesign/phoneid/response/PhoneIdLiveResponse.java index eebab69..3e07dd0 100644 --- a/src/com/telesign/phoneid/response/PhoneIdLiveResponse.java +++ b/src/com/telesign/phoneid/response/PhoneIdLiveResponse.java @@ -1,103 +1,228 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.phoneid.response; import com.google.gson.Gson; - -/** - * Google GSON mapped class to represent a TeleSign JSON response to a - * PhoneId.live() request - * - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford - */ +/** The PhoneIdLiveResponse class encapsulates all of the information returned from a call to the PhoneID Live web service. */ public class PhoneIdLiveResponse { + /** A String containing a reference identifier that uniquely identifies the Request message that initiated this Response. */ public String reference_id; + + /** A String containing the URI for accesses the PhoneID resource. */ public String resource_uri; + + /** A String containing the name of the subresource that was accessed. For example, "standard". */ public String sub_resource; + + /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */ public Error[] errors; + + /** An object that contains details about the phone type. */ public PhoneType phone_type; + + /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/ public String signature_string; + + /** An object containing details about the request status. */ public Status status; + + /** An object containing details about the numbering attributes of the specified phone number. */ public Numbering numbering; + + /** An object containing geographical location information associated with the phone number. */ public Location location; + + /** + * A JSON object containing details about a specified phone number’s state of operation. + * Note: In the case where PhoneID Live is not supported for the specified phone number, the server returns a Live object that is null. + */ public Live live; - public static class Error { + /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */ + public static class Error + { + /** A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */ public int code; + + /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */ public String description; } - + + /** An object containing details about the phone type. */ public static class PhoneType { + + /** One of the Phone Type Codes." */ public int code; + + /** A description of the phone type. */ public String description; } - + + /** An object containing details about the request status. */ public static class Status { + + /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */ public String updated_on; + + /** One of the Transaction Status Codes. */ public int code; + + /** A descriptionm of the transaction status. */ public String description; } - + + /** An object containing details about the numbering attributes of the specified phone number. */ public static class Numbering { + + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public OriginalNumber original; + + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public CleansingNumber cleansing; + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public static class OriginalNumber { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */ public String complete_phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; } + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public static class CleansingNumber { + + /** An object containing cleansing details about a phone number used for receiving text messages. */ public Number sms; + + /** An object containing cleansing details about a phone number used for receiving voice calls. */ public Number call; + + /** An object containing cleansing details about a phone number. */ public static class Number { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; + + /** The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int min_length; + + /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int max_length; + + /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */ public int cleansed_code; } } } - + + /** + * An object containing geographical location information associated with the phone number. + * Note: Location refers to the place where the phone is registered, not to where it actually is at the time of this request. + */ public static class Location { + + /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */ public String county; + + /** A string specifying the name of the city associated with the phone number. */ public String city; + + /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */ public String state; + + /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */ public String zip; + + /** An object containing details about the country associated with the phone number. */ public Country country; + + /** An object containing details about the Time Zone associated with the phone number. */ public TimeZone time_zone; + + /** An object containing details about the geographical coordinates of the location where the phone number is registered. */ public Coordinates coordinates; + + /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */ public String metro_code; + /** An object containing details about the country associated with the phone number. */ public static class Country { + + /** The ISO 3166-1 2-letter Country Code associated with the phone number. */ public String iso2; + + /** The ISO 3166-1 3-letter Country Code associated with the phone number */ public String iso3; + + /** The Country Name associated with phone number. */ public String name; } - + + /** An object containing details about the Time Zone associated with the phone number. */ public static class TimeZone { + + /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */ public String utc_offset_min; + + /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */ public String name; + + /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */ public String utc_offset_max; } - + + /** An object containing details about the geographical coordinates of the location where the phone number is registered. */ public static class Coordinates { + + /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */ public double latitude; + + /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */ public double longitude; } } - + + /** + * A JSON object containing details about a specified phone number’s state of operation. + * Note: In the case where PhoneID Live is not supported for the specified phone number, the server returns a Live object that is null. + */ public static class Live { + + /** A string indicating the current status of the subscriber’s phone number. */ public String subscriber_status; + + /** A string indicating the current status of the phone equipment. */ public String device_status; + + /** A string indicating whether the mobile device is currently roaming outside of the contracted service coverage area. */ public String roaming; + + /** The country in which the mobile device is roaming. */ public String roaming_country; } - + + /** + * Converts a PhoneIdLiveResponse object to its equivalent JSON format, using the {@link com.google.gson.Gson} class library. + * @see java.lang.Object#toString() + * @return A string containing the response from the TeleSign server, in JSON format. + * @see com.google.gson.Gson + */ @Override public String toString() { Gson gson = new Gson(); diff --git a/src/com/telesign/phoneid/response/PhoneIdScoreResponse.java b/src/com/telesign/phoneid/response/PhoneIdScoreResponse.java index 462d7ca..ed511c0 100644 --- a/src/com/telesign/phoneid/response/PhoneIdScoreResponse.java +++ b/src/com/telesign/phoneid/response/PhoneIdScoreResponse.java @@ -1,76 +1,149 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.phoneid.response; import com.google.gson.Gson; - -/** - * Google GSON mapped class to represent a TeleSign JSON response to a - * PhoneId.score() request - * - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford - */ +/** The PhoneIdScoreResponse class encapsulates all of the information returned from a call to the PhoneID Score web service. */ public class PhoneIdScoreResponse { + /** A String containing a reference identifier that uniquely identifies the Request message that initiated this Response. */ public String reference_id; + + /** A String containing the URI for accesses the PhoneID resource. */ public String resource_uri; + + /** A String containing the name of the subresource that was accessed. For example, "standard". */ public String sub_resource; + + /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */ public Error[] errors; + + /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/ public String signature_string; + + /** An object containing details about the request status. */ public Status status; + + /** An object containing details about the numbering attributes of the specified phone number. */ public Numbering numbering; + + /** An object that describes the risk score for the phone number specified in the request. */ public Risk risk; - public static class Error { + /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */ + public static class Error + { + /** A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */ public int code; + + /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */ public String description; } - + + /** An object containing details about the phone type. */ public static class PhoneType { + + /** One of the Phone Type Codes." */ public int code; + + /** A description of the phone type. */ public String description; } - + + /** An object containing details about the request status. */ public static class Status { + + /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */ public String updated_on; + + /** One of the Transaction Status Codes. */ public int code; + + /** A descriptionm of the transaction status. */ public String description; } - + + /** An object containing details about the numbering attributes of the specified phone number. */ public static class Numbering { + + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public OriginalNumber original; + + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public CleansingNumber cleansing; + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public static class OriginalNumber { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */ public String complete_phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; } + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public static class CleansingNumber { + + /** An object containing cleansing details about a phone number used for receiving text messages. */ public Number sms; + + /** An object containing cleansing details about a phone number used for receiving voice calls. */ public Number call; + + /** An object containing cleansing details about a phone number. */ public static class Number { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; + + /** The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int min_length; + + /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int max_length; + + /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */ public int cleansed_code; } } } - + + /** An object that describes the risk score for the phone number specified in the request. */ public static class Risk { + + /** A string indicating the severity of the risk. */ public String level; + + /** One of the Score values. */ public int score; + + /** A string indicating the action that TeleSign recommends that you take based on the risk score. */ public String recommendation; } - + + /** + * Converts a PhoneIdScoreResponse object to its equivalent JSON format. + * @see java.lang.Object#toString() + * @return A string containing the response from the TeleSign server, in JSON format, using the {@link com.google.gson.Gson} class library. + * @see com.google.gson.Gson + */ @Override public String toString() { Gson gson = new Gson(); return gson.toJson(this); } - } \ No newline at end of file diff --git a/src/com/telesign/phoneid/response/PhoneIdStandardResponse.java b/src/com/telesign/phoneid/response/PhoneIdStandardResponse.java index 7026ddd..4887ec1 100644 --- a/src/com/telesign/phoneid/response/PhoneIdStandardResponse.java +++ b/src/com/telesign/phoneid/response/PhoneIdStandardResponse.java @@ -1,97 +1,207 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.phoneid.response; import com.google.gson.Gson; - -/** - * Google GSON mapped class to represent a TeleSign JSON response to a - * PhoneId.standard() request - * - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford - */ -public class PhoneIdStandardResponse { +/** The PhoneIdStandardResponse class encapsulates all of the information returned from a call to the PhoneID Standard web service. */ +public class PhoneIdStandardResponse +{ + /** A String containing a reference identifier that uniquely identifies the Request message that initiated this Response. */ public String reference_id; + + /** A String containing the URI for accesses the PhoneID resource. */ public String resource_uri; + + /** A String containing the name of the subresource that was accessed. For example, "standard". */ public String sub_resource; + + /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */ public Error[] errors; + + /** An object that contains details about the phone type. */ public PhoneType phone_type; + + /** A String containing the Signature, exactly as it was sent in the Request. Unless the request contained an invalid Signature, this contains an empty string.*/ public String signature_string; + + /** An object containing details about the request status. */ public Status status; + + /** An object containing details about the numbering attributes of the specified phone number. */ public Numbering numbering; + + /** An object containing geographical location information associated with the phone number. */ public Location location; - - public static class Error { + + /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */ + public static class Error + { + /** A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */ public int code; + + /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */ public String description; } - + + /** An object containing details about the phone type. */ public static class PhoneType { + + /** One of the Phone Type Codes." */ public int code; + + /** A description of the phone type. */ public String description; } - + + /** An object containing details about the request status. */ public static class Status { + + /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */ public String updated_on; + + /** One of the Transaction Status Codes. */ public int code; + + /** A descriptionm of the transaction status. */ public String description; } - + + /** An object containing details about the numbering attributes of the specified phone number. */ public static class Numbering { + + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public OriginalNumber original; + + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public CleansingNumber cleansing; + /** An object containing details about the original phone number passed to TeleSign’s PhoneID API. */ public static class OriginalNumber { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** The Base Phone Number prefixed with the Country Dialing Code. This forms the Subresource Identifier part of the PhoneID Contact web service URI. */ public String complete_phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; } + /** An object containing details about how the phone number was cleansed. Phone Cleansing corrects common formatting issues in submitted phone numbers. */ public static class CleansingNumber { + + /** An object containing cleansing details about a phone number used for receiving text messages. */ public Number sms; + + /** An object containing cleansing details about a phone number used for receiving voice calls. */ public Number call; + + /** An object containing cleansing details about a phone number. */ public static class Number { + + /** The Base Phone Number. This is simply the phone number without the Country Dialing Code. */ public String phone_number; + + /** A 1, 2, or 3-digit number representing the Country Dialing Code. For example, the Country Dialing Code for both the U.S.A. and Canada is 1, and the Country Dialing Code for the United Kingdom is 44. */ public String country_code; + + /** The minimum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int min_length; + + /** The maximum number of digits allowed for phone numbers with this particular Country Dialing Code. */ public int max_length; + + /** One of the Phone Number Cleansing Codes describing the cleansing operation TeleSign performed on the phone number. The default value is 100 (No changes were made to the phone number). */ public int cleansed_code; } } } - + + /** + * An object containing geographical location information associated with the phone number. + * Note: Location refers to the place where the phone is registered, not to where it actually is at the time of this request. + */ public static class Location { + + /** A string specifying the name of the County (or Parish) associated with the phone number (U.S. only). */ public String county; + + /** A string specifying the name of the city associated with the phone number. */ public String city; + + /** The 2-letter State Code of the state (province, district, or territory) associated with the phone number (North America only). */ public String state; + + /** The 5-digit United States Postal Service ZIP Code associated with the phone number (U.S. only). */ public String zip; + + /** An object containing details about the country associated with the phone number. */ public Country country; + + /** An object containing details about the Time Zone associated with the phone number. */ public TimeZone time_zone; + + /** An object containing details about the geographical coordinates of the location where the phone number is registered. */ public Coordinates coordinates; + + /** A 4-digit string indicating the Primary Metropolitan Statistical Area (PMSA) Code for the location associated with the phone number (U.S. only). PMSA Codes are governed by the US Census Bureau. */ public String metro_code; + /** An object containing details about the country associated with the phone number. */ public static class Country { + + /** The ISO 3166-1 2-letter Country Code associated with the phone number. */ public String iso2; + + /** The ISO 3166-1 3-letter Country Code associated with the phone number */ public String iso3; + + /** The Country Name associated with phone number. */ public String name; } - + + /** An object containing details about the Time Zone associated with the phone number. */ public static class TimeZone { + + /** For U.S. domestic phone numbers, this parameter returns the UTC offset associated with the phone number. */ public String utc_offset_min; + + /** A string identifying the Time Zone Name (TZ) associated with the phone number (U.S. only). For example: "America/Los_Angeles". */ public String name; + + /** For international phone numbers, this parameter returns the maximum UTC offset for the country associated with the phone number. For U.S. domestic phone numbers, this parameter returns the same result as utc_offset_min. */ public String utc_offset_max; } - + + /** An object containing details about the geographical coordinates of the location where the phone number is registered. */ public static class Coordinates { + + /** A value indicating the number of degrees of latitude of the location associated with the phone number, expressed in seven decimal digits, with five decimal places. For example, 34.18264. */ public double latitude; + + /** A value indicating the number of degrees of longitude of the location associated with the phone number, expressed in eight decimal digits, with five decimal places For example, -118.30840. */ public double longitude; } } - + + /** + * Converts a PhoneIdStandardResponse object to its equivalent JSON format, using the {@link com.google.gson.Gson} class library. + * @see java.lang.Object#toString() + * @return A string containing the response from the TeleSign server, in JSON format. + * @see com.google.gson.Gson + */ @Override - public String toString() { + public String toString() + { Gson gson = new Gson(); return gson.toJson(this); } diff --git a/src/com/telesign/phoneid/response/package.html b/src/com/telesign/phoneid/response/package.html new file mode 100644 index 0000000..af0c397 --- /dev/null +++ b/src/com/telesign/phoneid/response/package.html @@ -0,0 +1,8 @@ + + + +

      + Contains a set of classes that represent TeleSign server response objects—one for each of the PhoneID web services. +

      + + \ No newline at end of file diff --git a/src/com/telesign/util/PhoneUtil.java b/src/com/telesign/util/PhoneUtil.java index d33e4ce..53e0bd9 100644 --- a/src/com/telesign/util/PhoneUtil.java +++ b/src/com/telesign/util/PhoneUtil.java @@ -1,62 +1,68 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.util; /** - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford + * The PhoneUtil class contains a mentod for normalizing phone numbers. */ -public class PhoneUtil { - +public class PhoneUtil +{ /** - * helper method to validate numbers to 11 digits - * - * @param phoneNumber - * @return the phone number validated to 11 digits + * This mentod is a helper method for cleansing phone numbers. + * Specifically, it ensures that all phone number conform to a standard 11 digit format. + * For example, (310) 555-1212 becomes 13105551212. + * @param phoneNumber [Required] A string that contains the user's phone number, in its original form. + * @return The cleansed form of the phone number. */ - public static String formatTo11Digits(String phoneNumber){ - if(phoneNumber == null) return null; - - //clean the phone number of anything but digits - String cleanPhone = phoneNumber.replaceAll("[^\\d]", ""); - - try { - Long.parseLong(cleanPhone); - } catch(NumberFormatException nfe) { - return null; - } - - switch(cleanPhone.length()) { - case 0: - case 1: - case 2: - case 3: - case 4: - case 5: - case 6: - case 7: - case 8: - case 9: - return null; - case 10: - return "1" + cleanPhone; - case 11: - return cleanPhone; - case 12: - //if the phone number is 12 digits and starts with 11 or 01, treat it as country code and omit - //example 113102669619 - if(cleanPhone.charAt(0) == '0') { - return cleanPhone.substring(1); - } - return null; - case 13: - if(cleanPhone.startsWith("00")){ - return cleanPhone.substring(2); - } - return null; - default: - return null; - } - } + public static String formatTo11Digits(String phoneNumber) + { + if(phoneNumber == null) return null; + // Remove non-numeric characters (leaving digits 0..9). + String cleanPhone = phoneNumber.replaceAll("[^\\d]", ""); + + // Assert that the characters in the cleaned phone number are all numeric. + try + { + Long.parseLong(cleanPhone); // Convert the string representation of the cleaned phone number to a long value. + } + catch(NumberFormatException nfe) + { + return null; + } + + switch(cleanPhone.length()) + { + case 0: case 1: case 2: case 3: case 4: + case 5: case 6: case 7: case 8: case 9: + return null; + case 10: // Missing the dialing code for North America (+1). + return "1" + cleanPhone; + case 11: + return cleanPhone; + case 12: + // If the phone number is 12 digits long, and begins with either "11" or "01", then treat it as country code and omit. + // For example 113102669619 + if(cleanPhone.charAt(0) == '0') + { + return cleanPhone.substring(1); // Remove the leading zero. + } + return null; + case 13: + if(cleanPhone.startsWith("00")) + { + return cleanPhone.substring(2); // Remove the leading two zeros. + } + return null; + default: + return null; + } + } } diff --git a/src/com/telesign/util/TeleSignRequest.java b/src/com/telesign/util/TeleSignRequest.java index 59b2dd5..d8ac093 100644 --- a/src/com/telesign/util/TeleSignRequest.java +++ b/src/com/telesign/util/TeleSignRequest.java @@ -1,4 +1,14 @@ +/** +f * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.util; + import java.io.BufferedReader; import java.io.DataOutputStream; import java.io.IOException; @@ -21,314 +31,472 @@ import org.apache.commons.codec.binary.Base64; /** - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford + * The TeleSignRequest class is an abstraction for creating and sending HTTP 1.1 + * REST Requests for TeleSign web services. */ public class TeleSignRequest { - - - /** - * The TeleSignRequest is the base for which all the TeleSign API requests. - * This class handles both GET and POST requests and the different signing - * methods for each. If specialized access or parameters are needed for the - * API over the defaults given in the @see PhoneId class or @see Verify class - * a custom request can be made using this class. - * - * @param base the base url of the request. This does not include parameters or the method - * of the call. Usually this is https://rest.telesign.com - * @param resource the resource called off the base url. This is the extension off the base - * of the url. Example "/v1/phoneid/standard/1234567890" - * @param method the method of the request. one of GET or POST - * @param customer_id the TeleSign provided customer_id - * @param secret_key the TeleSign provided secret_key - */ - public TeleSignRequest(String base, String resource, String method, String customer_id, String secret_key) { - - this.base = base; - this.resource = resource; - this.customer_id = customer_id; - this.secret_key = secret_key; - - post = (method.toLowerCase().equals("post")); - - ts_headers = new TreeMap(); - headers = new TreeMap(); - params = new HashMap(); - } - - - /** - * Add a header to this TeleSign Request. If the header starts with - * X-TS- it is added to a special list of TeleSign headers. This - * also checks for the presence of X-TS-Date to correctly set the - * date for the request whether the Specialize TeleSign Date header - * is set or if it should be generated at request time - * - * @param key the name of the header - * @param value the value to set for the heaader. - */ - public void addHeader(String key, String value) { - if((key.length() > 4) && (key.toLowerCase().substring(0, 5).equals("x-ts-"))) { - - //mark the date if it is found to not use normal date params - if(key.toLowerCase().equals("x-ts-date")) { - ts_date = true; - } - ts_headers.put(key, value); - } - headers.put(key, value); - } - - /** - * Add a parameter to the query String. Holds the parameters in a map - * until it is time to sign them - * - * @param key the name of the parameter - * @param value the value of the parameter - */ - public void addParam(String key, String value) { - params.put(key, value); + /** + * A boolean value indicates the Request Method. True for + * POST, and False for GET. + */ + private boolean post; + + /** + * The Base URI. For TeleSign web services, this is + * https://rest.telesign.com/. + */ + private final String base; + + /** + * The name of the network resource. Each of the TeleSign web services is + * identified by its resource specifier. + */ + private final String resource; + + /** Your TeleSign Customer ID. This represents your TeleSign account number. */ + private final String customer_id; + + /** + * Your TeleSign Secret Shared Key (available from the TeleSign Client + * Portal). + */ + private final String secret_key; + + /** The set of HTTP 1.1 Request header field/value pairs. */ + private TreeMap headers; + + /** The set of TeleSign-specific Request header field/value pairs. */ + private TreeMap ts_headers; + + /** The set of HTTP 1.1 Request parameter attribute/value pairs. */ + private HashMap params; + + /** The absolute form of the Resource URI */ + private URL url; + + /** The persistent session connection for the Request. */ + private HttpURLConnection connection; + + /** The contents of the entity body in the POST Request. */ + private String body = ""; + + /** + * A boolean value that indicates whether the TeleSign-specific + * Date Request header field is used. + */ + private boolean ts_date = false; + + /** + * The TeleSitgnRequest class constructor. A TeleSitgnRequest object + * contains all of the information required to call any/all of the TeleSign + * web services. + * + * @param base + * [Required] A string representing the Base URI. For TeleSign + * web services, this is https://rest.telesign.com/. + * @param resource + * [Required] A string representing the name of the network + * resource. Each of the TeleSign web services is identified by + * its resource specifier. + * @param method + * [Required] A string representing the method to be performed on + * the resource. For TeleSign web services, this is either GET or + * POST. + * @param customer_id + * [Required] A string representing your TeleSign Customer ID. + * This represents your TeleSign account number. + * @param secret_key + * [Required] A string representing your TeleSign Secret Shared + * Key (available from the TeleSign Client Portal). + */ + public TeleSignRequest(String base, String resource, String method, + String customer_id, String secret_key) { + post = (method.toLowerCase().equals("post")); + + this.base = base; + this.resource = resource; + this.customer_id = customer_id; + this.secret_key = secret_key; + + ts_headers = new TreeMap(); + headers = new TreeMap(); + params = new HashMap(); + } + + /** + * Adds an HTTP 1.1 Request header field/value pair to the set of Request + * Headers. + * + * @param key + * [Required] A string representing a Request header field + * name. + * @param value + * [Required] A string representing a Request header field + * value. + */ + public void addHeader(String key, String value) { + // Check to see if this request header field is a "TeleSign-specific" + // header field. + if ((key.length() > 4) + && (key.toLowerCase().substring(0, 5).equals("x-ts-"))) { + // If using the TeleSign-specific date header, then use a blank line + // for the standard Date Request header. + if (key.toLowerCase().equals("x-ts-date")) + ts_date = true; + + ts_headers.put(key, value); } - - - /** - * Set the body of the request for POST requests - * - * @param post_body - */ - public void setPostBody(String post_body) { - body = post_body; + + headers.put(key, value); + } + + /** + * Adds an HTTP 1.1 Request parameter attribute/value pair to the set of + * Request Parameters. + * + * @param key + * [Required] A string representing a Request parameter attribute + * name. + * @param value + * [Required] A string representing a Request parameter attribute + * value. + */ + public void addParam(String key, String value) { + params.put(key, value); + } + + /** + * Sets the entity body of an HTTP 1.1 POST Request message. Contains the + * Request parameters for Verify.call and + * Verify.sms. + * + * @param post_body + * [Required] A string that contains the contents of the POST + * Request's entity body. + */ + public void setPostBody(String post_body) { + body = post_body; + } + + /** + * Gets the entity body of an HTTP 1.1 POST Request message. Used for calls + * to Verify.call and Verify.sms. + * + * @return A string that contains the contents of the POST Request's entity + * body. + */ + public String getPostBody() { + return body; + } + + /** + * Returns the set of TeleSign-specific Request header fields. + * + * @return A sorted key/value mapping that contains the TeleSign-specific + * Request header fields. + */ + public Map getTsHeaders() { + return ts_headers; + } + + /** + * Returns the set of both the standard and the + * TeleSign-specific Request header fields. + * + * @return A sorted key/value mapping that contains all of the Request + * header fields. + */ + public Map getAllHeaders() { + TreeMap tmp = new TreeMap(); + + tmp.putAll(headers); + tmp.putAll(ts_headers); + + return tmp; + } + + /** + * Returns the set of POST Request parameters. + * + * @return A sorted key/value mapping that contains all of the POST Request + * parameters. + */ + public Map getAllParams() { + return params; + } + + /** + * Creates and sends the REST request. + * + * @return A string containing the TeleSign web server's Response. + * @throws IOException + * A {@link java.security.SignatureException} signals that an + * error occurred while attempting to sign the Request. + */ + public String executeRequest() throws IOException { + String signingString = getSigningString(customer_id); + String signature; + String url_output = ""; + + // Create the absolute form of the resource URI, and place it in a + // string buffer. + StringBuffer full_url = new StringBuffer(base).append(resource); + + if (params.size() > 0) { + full_url.append("?"); + int i = 0; // The first parameter is always prefixed with a question + // mark. + + for (String key : params.keySet()) { + if (++i != 0) // Additonal parameters are always prefixed with + // an ampersands. + full_url.append("&"); + + full_url.append(URLEncoder.encode(key, "UTF-8")).append("=") + .append(URLEncoder.encode(params.get(key), "UTF-8")); + } } - - /** - * Get the POST body for this request - * - * @return the string value of the POST request + + /* + * Convert the URL string into a URL object, to use later for creating a + * persistent connection for the session. */ - public String getPostBody() { - return body; - } - - /** - * Return a sorted list of all the headers. - * - * @return a sorted map of all the headers for this request + url = new URL(full_url.toString()); + + /* + * Create the Signature using the formula: Signature = Base64( + * HMAC-SHA1( YourTeleSignAPIKey, UTF-8-Encoding-Of( StringToSign ) ) */ - public Map getAllHeaders() { - TreeMap tmp = new TreeMap(); - tmp.putAll(headers); - tmp.putAll(ts_headers); - return tmp; + try { + signature = hmacsha1(signingString, secret_key); + } catch (SignatureException e) { + System.err.println("Error signing request " + e.getMessage()); + + return null; } - - /** - * Return the TeleSign specific Headers set for this request - * - * @return the map of the TeleSign specific headers. This map returns a sorted order + + /* + * Create the Authorization header using the following formula: + * Authorization = "TSA" + " " + Customer ID + ":" + Signature. */ - public Map getTsHeaders() { - return ts_headers; - } - - /** - * Return all the Query parameters set on this request. - * - * @return a map containing all the query parameters set for this request + String auth_header = "TSA" + customer_id + ":" + signature; + + /* + * Create an HTTP Connection object to open a persistent connection to + * the URL, and begin a new session for the Request/Response + * transaction. */ - public Map getAllParams() { - return params; + connection = (HttpURLConnection) url.openConnection(); + connection.setConnectTimeout(30000); + + // Send the Request message headers to the web resource. + connection.setRequestProperty("Authorization", auth_header); // Send the + // Authorization + // header. + + if (post) // This Request message contains an enitiy body, so + connection.setRequestProperty("Content-Length", + Integer.toString(body.length())); // Send the size of the + // message payload as + // the value of the + // Content-Length header. + for (String key : ts_headers.keySet()) + connection.setRequestProperty(key, ts_headers.get(key)); // Add the + // TeleSign-specific + // Request + // headers. + + for (String key : headers.keySet()) + connection.setRequestProperty(key, headers.get(key)); // Add the + // generl + // Request + // headers. + + if (post) // This Request message contains an enitiy body, so + { // use the connection for outputting (writing a stream of) + // information, + connection.setDoOutput(true); // as opposed to false, for inputting. + + DataOutputStream wr = new DataOutputStream( + connection.getOutputStream()); + + wr.writeBytes(body); // Write the entity body for the POST Request. + wr.flush(); + wr.close(); } - - /** - * Sign and make the TeleSign Request to the url that was set on this request. - * The signature is then calculated based on the headers, post parameters and - * resource as described below. - * - * Authorization = "TSA" + " " + Customer ID + ":" + Signature - * - * Signature = Base64( HMAC-SHA1( YourTeleSignAPIKey, UTF-8-Encoding-Of( StringToSign ) ) ) - * - * StringToSign = HTTP-method + "\n" + - * Content-Type + "\n" + - * Date + "\n" + - * CanonicalizedTsHeaders + - * CanonicalizedPOSTVariables + - * CanonicalizedResource - * - * - *

      - * https://portal.telesign.com/docs/content/rest-auth.html - * - * @return A string containing the JSON string response that was returned from the html request - * @throws IOException - */ - public String executeRequest() throws IOException { - String signingString = getSigningString(customer_id); - String signature; - String url_output = ""; - - /* construct the full url */ - StringBuffer full_url = new StringBuffer(base).append(resource); - if(params.size() > 0) { - full_url.append("?"); - int i =0; - for(String key : params.keySet()) { - if(++i != 0) { //don't add the ampersand on the first iteration - full_url.append("&"); - } - - full_url.append(URLEncoder.encode(key, "UTF-8")).append("=").append(URLEncoder.encode(params.get(key), "UTF-8")); - } - } - - url = new URL(full_url.toString()); - connection = (HttpURLConnection) url.openConnection(); - connection.setConnectTimeout(30000); - - - try { - signature = hmacsha1(signingString, secret_key); - } catch (SignatureException e) { - System.err.println("Error signing request " + e.getMessage()); - return null; - } - - String auth_header = "TSA " + customer_id + ":" + signature; - - connection.setRequestProperty("Authorization", auth_header); - - if(post) { - connection.setRequestProperty("Content-Length", Integer.toString(body.length())); - } - - for(String key : ts_headers.keySet()) { - connection.setRequestProperty(key, ts_headers.get(key)); - } - - for(String key : headers.keySet()) { - connection.setRequestProperty(key, headers.get(key)); - } - - if(post) { - connection.setDoOutput(true); - DataOutputStream wr = new DataOutputStream ( - connection.getOutputStream ()); - wr.writeBytes(body); - wr.flush(); - wr.close(); - } - - int response = connection.getResponseCode(); - - BufferedReader in; - try { - InputStream isr = (response == 200) ? connection.getInputStream() : connection.getErrorStream(); - in = new BufferedReader(new InputStreamReader(isr)); - String urlReturn; - - while ((urlReturn = in.readLine()) != null) { - url_output += urlReturn; - } - in.close(); - } catch (IOException e) { - System.err.println("IOException while reading from input stream " + e.getMessage()); - } - - - return url_output; + + // Sending Request now complete. + + // Retrieve the Status Code from the web server. The Status-Code is a + // 3-digit integer that indicates the result + int response = connection.getResponseCode(); // of the web server's + // attempt to understand + // and satisfy your + // request. + + // Retrieve the contents of the Response message from the TeleSign + // server. + BufferedReader in; + + try { + // Extract the the contents of the Response message with a stream + // object. + InputStream isr = (response == 200) ? connection.getInputStream() + : connection.getErrorStream(); // When successful, the value + // is "200". + + in = new BufferedReader(new InputStreamReader(isr)); // Read the + // input stream + // into a + // buffer. + + String urlReturn; // Transfer the contents of the buffer to string + // variable. + + while ((urlReturn = in.readLine()) != null) + // The response headers are separated using the new line + // character ("\n"). + url_output += urlReturn; // Information returned in the response + // body is structured in JSON format. + + in.close(); + } catch (IOException e) { + System.err.println("IOException while reading from input stream " + + e.getMessage()); } - - /** - * Only run when the request is executed - * - * @param customer_id - * @return the string to sign for the request + + return url_output; + } + + /** + * Create the string to sign. This is a helper method, + * used interanlly by the + * {@link com.telesign.util.TeleSignRequest#executeRequest()} method. + * + * @param customer_id + * [Required] A string representing your TeleSign Customer ID. + * This represents your TeleSign account number. + * @return A string representing the signing string used to create a + * Signature object, for the authenticate the REST request. + */ + private String getSigningString(String customer_id) { + // Create the stringToSign element of the Signature component. + String stringToSign = post ? "POST\n" : "GET\n"; + String content_type = post ? "application/x-www-form-urlencoded\n" + : "\n"; + + // Concatonate the Request headers to the stringToSign. + stringToSign += content_type; + + /* + * Add the Date header to both the set of Headers, /* and to the + * stringToSign (killing two birds with one stone). */ - private String getSigningString(String customer_id) { - String stringToSign = post ? "POST\n": "GET\n"; - String content_type = post ? "application/x-www-form-urlencoded\n" : "\n"; - - /* set the content type */ - stringToSign += content_type; - - /* Handle the Date */ - if(ts_date) { - stringToSign += "\n"; - } else { - - Date now = new Date(); - //Tue, 10 Jan 2012 19:36:42 +0000 - SimpleDateFormat rfc2616 = new SimpleDateFormat("EEE, dd MMM YYYY HH:mm:ss ZZZZ"); - String date = rfc2616.format(now); - addHeader("Date", date); - stringToSign += date + "\n"; - } - - //canonize the ts_headers - Set orderedKeys = ts_headers.keySet(); - for(String key : orderedKeys) { - stringToSign += key.toLowerCase() + ":" + ts_headers.get(key) + "\n"; - } - - if(post) { - stringToSign += body + "\n"; - } - - stringToSign += resource; - - return stringToSign; + if (ts_date) // If you use the TeleSign-specific Date header, + stringToSign += "\n"; // then the standard Date header isn't + // required, + else // so just insert an empty line into the StringToSign (as a + // placeholder). + { + // Create a standard HTTP 1.1 Date header field. + Date now = new Date(); + + /* + * Convert the Date object to conform to the RFC 2616, Section 3.3.1 + * format. For example : Tue, 10 Jan 2012 19:36:42 +0000. + */ + SimpleDateFormat rfc2616 = new SimpleDateFormat( + "EEE, dd MMM YYYY HH:mm:ss ZZZZ"); + String date = rfc2616.format(now); + addHeader("Date", date); + + stringToSign += date + "\n"; } - - /** - * Perform a hmac sha1 hash of the passed string using the passed salt - * @param data The information to hash - * @param key the salt of the hash - * @return a hashed and base64 encoded representation of the data and the salt - * @throws java.security.SignatureException + + /* + * Create the CanonicalizedTsHeaders element. This entails: Converting + * header names to lowercase, Sorting the set by header name, Ensuring + * that each X-TS- header name appears just once, Unfolding long header + * values that span multiple lines, by replacing the folding white space + * (newline) with a single space, and Removing white space surrounding + * the colon that appears between each header name/value pair. */ - private String hmacsha1(String data, String key) throws java.security.SignatureException { - String HMAC_SHA1_ALGORITHM = "HmacSHA1"; - String result; - - byte[] decoded_key = Base64.decodeBase64(key); - - try { - // get an hmac_sha1 key from the raw key bytes - SecretKeySpec signingKey = new SecretKeySpec(decoded_key, HMAC_SHA1_ALGORITHM); - - // get an hmac_sha1 Mac instance and initialize with the signing key - Mac mac = Mac.getInstance(HMAC_SHA1_ALGORITHM); - mac.init(signingKey); - - // compute the hmac on input data bytes - byte[] rawHmac = mac.doFinal(data.getBytes()); - - // base64-encode the hmac - result = new String(Base64.encodeBase64(rawHmac)); - - } catch (Exception e) { - throw new SignatureException("Failed to generate HMAC : " + e.getMessage()); - } - - return result; + Set orderedKeys = ts_headers.keySet(); + + for (String key : orderedKeys) + // Add each of the X-TS- headers (name:value pairs) to the + // stringToSign, + stringToSign += key.toLowerCase() + ":" + ts_headers.get(key) + + "\n"; // each one separated by a newline. + + // Create the CanonicalizedPOSTVariables element. + if (post) + stringToSign += body + "\n"; // Just concatonate the POST Request + // entity body "as-is" to the + // stringToSign. + + // Create the CanonicalizedResource element. + stringToSign += resource; // Just concatonate the resource "as-is" to + // the stringToSign. + + return stringToSign; + } + + /** + * Creates the Signature component for the Authorization header field. Uses + * your Secret Key to encode the stringToSign. This is a + * helper method, used interanlly by the + * {@link TeleSignRequest#executeRequest()} method. + * + * @param data + * [Required] The stringToSign. + * @param key + * [Required] Your TeleSign API Key. Also known as your Secret + * Key, and your Shared Cryptographic Key. It s a bese64-encoded + * string value. + * @return A String containing the Base64-encoded hash-based message + * authentication code. + * @throws java.security.SignatureException + * Failed to generate HMAC. IllegalArgumentException - if + * algorithm is null or key is null or empty. + */ + private String hmacsha1(String data, String key) + throws java.security.SignatureException { + String HMAC_SHA1_ALGORITHM = "HmacSHA1"; + String result; + + byte[] decoded_key = Base64.decodeBase64(key); // Get the raw key value. + + try { + /* + * Construct a another secret key from the raw key, one that can be + * used with the specified cryptographic hash algorithm. + */ + SecretKeySpec signingKey = new SecretKeySpec(decoded_key, + HMAC_SHA1_ALGORITHM); + + // Create a MAC object, which implements the SHA-1 hash algorithm. + Mac mac = Mac.getInstance(HMAC_SHA1_ALGORITHM); + mac.init(signingKey); // Use the new encryption key to for + // encrypting the stringToSign. + + // Encrypt the stringToSign. + byte[] rawHmac = mac.doFinal(data.getBytes()); // This renders the + // encrypted for of + // the stringToSign + // as chunk of binary + // data. + + // Encode the binary data into an ASCII string format - so it can be + // sent reliably over the Internet (a medium originally designed for + // transporting textual data). + result = new String(Base64.encodeBase64(rawHmac)); + + } catch (Exception e) { + throw new SignatureException("Failed to generate HMAC : " + + e.getMessage()); } - - private TreeMap ts_headers; - private TreeMap headers; - - private HashMap params; - - private URL url; - private HttpURLConnection connection; - private boolean post; - private String body = ""; - - private final String base; - private final String resource; - private final String customer_id; - private final String secret_key; - - private boolean ts_date = false; + + return result; + } } diff --git a/src/com/telesign/util/package.html b/src/com/telesign/util/package.html new file mode 100644 index 0000000..513635a --- /dev/null +++ b/src/com/telesign/util/package.html @@ -0,0 +1,8 @@ + + + +

      + Contains a class for normalizing a phone number, and a class that represents a TeleSign service request object. +

      + + \ No newline at end of file diff --git a/src/com/telesign/verify/Verify.java b/src/com/telesign/verify/Verify.java index 3ed195e..bd6c8cb 100644 --- a/src/com/telesign/verify/Verify.java +++ b/src/com/telesign/verify/Verify.java @@ -1,188 +1,194 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.verify; -import java.io.IOException; -import java.net.URLEncoder; - import com.google.gson.Gson; import com.telesign.util.PhoneUtil; import com.telesign.util.TeleSignRequest; import com.telesign.verify.response.VerifyResponse; - +import java.io.IOException; +import java.net.URLEncoder; /** - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford + * The Verify class abstracts your interactions with the TeleSign Verify web service. + * A Verify object encapsulates your credentials (your TeleSign Customer ID and Secret Key). */ -public class Verify { - +public class Verify +{ /** - * Implementation of the TeleSign Verify api - * - *

      - * https://portal.telesign.com/docs/content/verify.html - * - * - * Simple constructor for setting the customer id and secret_key - * @param customer_id the TeleSign customer id. - * @param secret_key the TeleSign secret key + * The Verify class constructor. + * Once you instantiate a Verify object, you can use it to make instance calls to Verify SMS and Verify Call. + * @param customer_id [Required] A string representing your TeleSign Customer ID (your TeleSign account number). + * @param secret_key [Required] A string representing your TeleSign Secret Key (a bese64-encoded string valu, available from the TeleSign Client Portal). */ - public Verify(String customer_id, String secret_key) { + public Verify(String customer_id, String secret_key) + { this.customer_id = customer_id; this.secret_key = secret_key; } /** - * Convenience method an overload of {@link com.telesign.verify.Verify#sms(String, String, String, String)} - * - * @param identifier the phone number to send the sms message - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply + * Delivers a verification code to the end user by sending it in a text message. + * This is the simplest of the three overloads of this method. This overload takes the only required paramter—the end user's phone number. + * @param identifier [Required] A string representing the user’s phone number. + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse sms(String identifier) { + public VerifyResponse sms(String identifier) + { return sms(identifier, null, null, null); } /** - * Convenience method an overload of {@link com.telesign.verify.Verify#sms(String, String, String, String)} - * - * @param identifier the phone number to send the sms message - * @param language The String representation of the language to send the sms message - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply + * Delivers a verification code to the end user by sending it in a text message. + * Use this overload when the end user's written language isn't the default language (English). + * @param identifier [Required] A string representing the user’s phone number. + * @param language [Optional] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default). + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse sms(String identifier, String language) { + public VerifyResponse sms(String identifier, String language) + { return sms(identifier, language, null, null); } /** - * Make a Verify SMS request to TeleSign's API. This method allows - * the language, verification code and template of the message to be set. - * - *

      - * https://portal.telesign.com/docs/content/verify-sms.html - * - * @param identifier the phone number to send the sms message - * @param language The String representation of the language to send the sms message - * @param verify_code The code to send via sms. Set to null to let Telesign generate the code - * @param template The template of the message that is being sent. Set to null for default, otherwise must include $$CODE$$ as a variable placeholder - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply + * Delivers a verification code to the end user by sending it in a text message. + * Use this overload when the end user's written language isn't the default language (English), or when you want to send them a verification code that you create, or when you want to apply a custom text message template. + * @param identifier [Required] A string representing the user’s phone number. + * @param language [Optional] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default). + * @param verify_code [Optional] A string representing the verification code that you want to send to the end user. TeleSign will automatically generate a verification code for you if to set this value to null. + * @param template [Optional] A string representing a text message to override the predefined text message template. Your text message must incorporate a $$CODE$$ placeholder to integrate the verify_code field. Set this value to null (the default) to use the predefined template. + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse sms(String identifier, String language, String verify_code, String template) { + public VerifyResponse sms(String identifier, String language, String verify_code, String template) + { String result = null; - try { + + try + { String clean_phone = PhoneUtil.formatTo11Digits(identifier); - TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/sms", "POST", customer_id, secret_key); - - String body = "phone_number=" + URLEncoder.encode(clean_phone, "UTF-8");; + TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/sms", "POST", customer_id, secret_key); + String body = "phone_number=" + URLEncoder.encode(clean_phone, "UTF-8"); - if(language != null) { - body += "&language=" + URLEncoder.encode(language, "UTF-8");; + if(language != null) + { + body += "&language=" + URLEncoder.encode(language, "UTF-8"); } - if(verify_code != null) { - body += "&verify_code=" + URLEncoder.encode(verify_code, "UTF-8");; + if(verify_code != null) + { + body += "&verify_code=" + URLEncoder.encode(verify_code, "UTF-8"); } - if(template != null) { - body += "&template=" + URLEncoder.encode(template, "UTF-8");; + if(template != null) + { + body += "&template=" + URLEncoder.encode(template, "UTF-8"); } tr.setPostBody(body); result = tr.executeRequest(); - } catch (IOException e) { + + } + catch (IOException e) + { System.err.println("IOException while executing phoneid API: " + e.getMessage()); } Gson gson = new Gson(); VerifyResponse response = gson.fromJson(result, VerifyResponse.class); - return response; - + return response; } /** - * Convenience method for {@link com.telesign.verify.Verify#call(String, String, String, String, int, String, boolean)} - * - * @param identifier Required, the phone number of the person to dial - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply + * Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code. + * This is the simplest of the three overloads of this method. This overload takes the only required paramter—the end user's phone number. + * @param phone_number [Required] A string representing the user’s phone number. + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse call(String identifier) { - return call(identifier, null, null, null, 0, null, true); + public VerifyResponse call(String phone_number) + { + return call(phone_number, null, null, null, 0, null, true); } /** - * Convenience method for {@link com.telesign.verify.Verify#call(String, String, String, String, int, String, boolean)} - * - * @param identifier Required, th phone number of the person to dial - * @param language optional can be null. The language code of the call - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply + * Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code. + * Use this overload when the end user's spoken language isn't the default language (English). + * @param phone_number [Required] A string representing the user’s phone number. + * @param language [Required] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default). + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse call(String identifier, String language) { - return call(identifier, language, null, null, 0, null, true); + public VerifyResponse call(String phone_number, String language) + { + return call(phone_number, language, null, null, 0, null, true); } /** - * Make a Verify API call to TeleSigns phone service. Calling this method - * results in an automated phone call made to the given identifier. The language - * is specified as a string. Extensions and delays are programmable using the - * extension_type and extension template. - * - *

      - * https://portal.telesign.com/docs/content/verify-call.html - * - * @param identifier Required, the phone number of the person to dial - * @param language optional can be null. The language code of the call - * @param verify_code optional. if null, verify code will be generated by telesign - * @param verify_method optional. Only available option is currently null (dictated code) or "keypress" - * @param extension_type optional. If 0, no extension. if 1, DTMF extension. If 2, voice extension - * @param extension_template optional. If null not used. Otherwise the extension to reach - * @param redial optional. Default true - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply - * - * + * Delivers a verification code to the end user with a phone call. When the user answers their phone, the TeleSign server plays an automated voice message that contains the code. + * Use this overload when the end user's written language isn't the default language (English), or when you want to send them a verification code that you create, or when you need to specify a method for handling automated interactions with a PBX . + * @param phone_number [Required] A string representing the user’s phone number. + * @param language [Required] A string representing the IETF language tag used in applying predefined templates. For example, "fr-CA". Set this value to null for English (the default). + * @param verify_code [Optional] A string representing the verification code that you want to send to the end user. TeleSign will automatically generate a verification code for you if to set this value to null. + * @param verify_method [Optional] A string representing the input method you want the end user to use when returning the verification code. Use a value of "keypress" when you want the user to use their phone to dial the code. Set this value to null when you want the user to enter the code into your web aplication (the default). + * @param extension_type [Optional] An Integer value representing the type of response to use when dialing into a Private Branch Exchange (PBX). Use a value of 1 to have TeleSign use Dual-Tone Multi-Frequency (DTMF) tones to dail the user's extension. Use a value of 2 to have TeleSign use voice automation to request the user's extension. Use a value of 0 (the default) when the user isn't behind a PBX. + * @param extension_template [Optional] A numerical string specifying the user's PBX extension number. Since this value is used in the callstring, you can include one second pauses by adding commas before the extension number. Set this value to null (the default) if not used. + * @param redial [Optional] A boolean value that enables/disables redialing. Set this value to "true" (the default) when you want TeleSign to reattempt the call after a failed attempt. Set this value to "false" when you don't. + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse call(String identifier , String language, String verify_code, String verify_method, int extension_type, String extension_template, boolean redial) { - + public VerifyResponse call(String phone_number, String language, String verify_code, String verify_method, int extension_type, String extension_template, boolean redial) + { String result = null; - try { - String clean_phone = PhoneUtil.formatTo11Digits(identifier); - TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/call", "POST", customer_id, secret_key); - - String body = "phone_number=" + URLEncoder.encode(clean_phone, "UTF-8");; + + try + { + String clean_phone = PhoneUtil.formatTo11Digits(phone_number); + TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/call", "POST", customer_id, secret_key); + String body = "phone_number=" + URLEncoder.encode(clean_phone, "UTF-8"); - if(language != null) { - body += "&language=" + URLEncoder.encode(language, "UTF-8");; + if(language != null) + { + body += "&language=" + URLEncoder.encode(language, "UTF-8"); } - if(verify_code != null) { - body += "&verify_code=" + URLEncoder.encode(verify_code, "UTF-8");; + if(verify_code != null) + { + body += "&verify_code=" + URLEncoder.encode(verify_code, "UTF-8"); } - if(verify_method != null && verify_method.equalsIgnoreCase("keypress")) { - body += "&verify_method=" + URLEncoder.encode(verify_method, "UTF-8");; - } - if(extension_type > 0 && extension_type < 3) { - body += "&extension_type=" + URLEncoder.encode(Integer.toString(extension_type), "UTF-8");; + if(verify_method != null && verify_method.equalsIgnoreCase("keypress")) + { + body += "&verify_method=" + URLEncoder.encode(verify_method, "UTF-8"); } - if(extension_template != null) { - body += "&extension_template=" + URLEncoder.encode(extension_template, "UTF-8");; + + if(extension_type > 0 && extension_type < 3) + { + body += "&extension_type=" + URLEncoder.encode(Integer.toString(extension_type), "UTF-8"); } - if(!redial) { //only set this if it is false - body += "&redial=" + URLEncoder.encode(Boolean.toString(redial), "UTF-8");; + + if(extension_template != null) + { + body += "&extension_template=" + URLEncoder.encode(extension_template, "UTF-8"); } + if(!redial) // Set this only if it is false. + { + body += "&redial=" + URLEncoder.encode(Boolean.toString(redial), "UTF-8"); + } tr.setPostBody(body); result = tr.executeRequest(); - } catch (IOException e) { + + } + catch (IOException e) + { System.err.println("IOException while executing phoneid API: " + e.getMessage()); } @@ -193,20 +199,23 @@ public VerifyResponse call(String identifier , String language, String verify_co } /** - * Return the results of the post referenced by the reference_id. After a verify - * SMS or Call has been made, the status of that verification request can be retrieved - * with this method. - * - * @param resource_id the id returned from either requestsSMS or requestCall - * @return {@link com.telesign.verify.response.VerifyResponse VerifyResponse} The fully formed - * response object repersentation of the JSON reply + * Retrieves the status of a phone verification (for either SMS or Call). + * Call this method as a follow-up, after sending a verification code to an end user. + * This method takes only one paramter—the reference identifier that you received from TeleSign after calling either {@link com.telesign.verify#sms()} or {@link com.telesign.verify#call()}. + * @param resource_id [Required] The string value that uniquely identifies a Phone Verify service transaction. Each time you make a Phone Verify call, the TeleSign server responds with this auto-generated value. + * @return A {@link com.telesign.verify.response.VerifyResponse} object, which contains the JSON-formatted response body from the TeleSign server. */ - public VerifyResponse status(String resource_id) { + public VerifyResponse status(String resource_id) + { String result = null; - try { + + try + { TeleSignRequest tr = new TeleSignRequest("https://rest.telesign.com", "/v1/verify/" + resource_id, "GET", customer_id, secret_key); result = tr.executeRequest(); - } catch (IOException e) { + } + catch (IOException e) + { System.err.println("IOException while executing phoneid API: " + e.getMessage()); } @@ -214,8 +223,7 @@ public VerifyResponse status(String resource_id) { VerifyResponse response = gson.fromJson(result, VerifyResponse.class); return response; - } - + } private final String customer_id; private final String secret_key; diff --git a/src/com/telesign/verify/package.html b/src/com/telesign/verify/package.html new file mode 100644 index 0000000..8e725d2 --- /dev/null +++ b/src/com/telesign/verify/package.html @@ -0,0 +1,13 @@ + + + +

      + Contains the Verify class, which abstracts calls to the TeleSign Verify Web Service. +

      +

      + The Phone Verify web service provides an identity verification solution that uses the telephone to deliver a one-time validation code to your end users. + Upon receiving this code, your users just type it into their computer and send it back to you (or to us if they dial it into their phone). + The validity of their identity is then determined by simply comparing the codes they return to the ones we send them—and a match is considered positive identification. +

      + + \ No newline at end of file diff --git a/src/com/telesign/verify/response/VerifyResponse.java b/src/com/telesign/verify/response/VerifyResponse.java index b90a42f..1032c90 100644 --- a/src/com/telesign/verify/response/VerifyResponse.java +++ b/src/com/telesign/verify/response/VerifyResponse.java @@ -1,41 +1,74 @@ +/** + * @version 1.0 + * @copyright Copyright © 2013, TeleSign Corporation. + * @license http://opensource.org/licenses/mit-license.php The MIT License (MIT). + * @author J. Weatherford + * @maintainer Humberto Morales + * @repository https://github.com/TeleSign/java_telesign + * @support support@telesign.com + */ package com.telesign.verify.response; import com.google.gson.Gson; -/** - * Google GSON mapped class to represent a TeleSign JSON response to a - * Verify.sms(), Verify.call() and Verify.status() requests - * - * - * Copyright (c) TeleSign Corporation 2012. - * License: MIT - * Support email address "support@telesign.com" - * Author: jweatherford - */ +/** The VerifyResponse class encapsulates all of the information returned from a call to either the Verify SMS web service, or to the Verify Call web service. */ public class VerifyResponse { + /** A String containing a reference identifier that uniquely identifies the Request message that initiated this Response. */ public String reference_id; + + /** A String containing the URI for accesses the PhoneID resource. */ public String resource_uri; + + /** A String containing the name of the subresource that was accessed. For example, "standard". */ public String sub_resource; + + /** An array of {@link Error} objects. Each Error object contains information about an error condition that might have resulted from the Request. */ public Error[] errors; + + /** An object containing details about the request status. */ public Status status; + + /** An object that describes the verification status. */ public Verify verify; - public static class Error { + /** An array of property-value pairs, that contain information on error conditions that might have resulted from the Request. */ + public static class Error + { + /** A 1 to 5-digit error code (possibly negative) that indicates the type of error that occurred. When no error occurs, the default value 0 is returned. */ public int code; + + /** A string that describes the type of error that occurred. If no error occurs, this parameter is empty. */ public String description; } - + + /** An object containing details about the request status. */ public static class Status { + + /** An ISO 8601 UTC timestamp indicating when the transaction status was updated. */ public String updated_on; + + /** One of the Transaction Status Codes. */ public int code; + + /** A descriptionm of the transaction status. */ public String description; } - + + /** An object that describes the verification status. */ public static class Verify { + + /** Indicates whether the verification code entered matches that which was sent. Possible values are VALID, INVALID, or UNKNOWN. When the code entered matches the code sent, the response will be VALID. When the code entered does not match the code sent, code_state will be INVALID. */ public String code_state; + + /** Always set to an empty string. */ public String code_entered; } - + + /** + * Converts a VerifyResponse object to its equivalent JSON format. + * @see java.lang.Object#toString() + * @return A string containing the response from the TeleSign server, in JSON format. + */ @Override public String toString() { Gson gson = new Gson(); diff --git a/src/com/telesign/verify/response/package.html b/src/com/telesign/verify/response/package.html new file mode 100644 index 0000000..df62dfa --- /dev/null +++ b/src/com/telesign/verify/response/package.html @@ -0,0 +1,8 @@ + + + +

      + Contains a class that represents the TeleSign server response object for the Phone Verify web service. +

      + + \ No newline at end of file From 2523d0447c83af41410d23c5202252804e4b80ec Mon Sep 17 00:00:00 2001 From: Chris Boorman Date: Wed, 13 Mar 2013 20:55:56 -0700 Subject: [PATCH 2/2] Updated my .gitignore file Wanted to exclude the Javadoc-built files. --- .gitignore | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 91da6aa..05e2c1a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,15 @@ -*.class +# Build & Release Folders. +bin/ +doc/ -# Package Files # -*.war -*.ear -*.swp +# Package Files +.war +.ear +.swp + +# Compiled Java files. +.class + +# Experimental Bits +# The output from an XML Doclet. +jel/