nextcaller_client 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3dad21050c4c7b20a11909629c5ac046c510e01f
-  data.tar.gz: e3d576fc8338e4e4ead88b24ba6b048c186d5f24
+  metadata.gz: 81106706a54902bfaa5b02fe44a008b2aa51ec77
+  data.tar.gz: ac38872c66caa64f1e0d52c256f77758ae3d0385
 SHA512:
-  metadata.gz: ee989ed5e9e42a07fabf5d6b4337d864e93a54d16efd3a0da4d833707907c7cdaafda820a606d894e449ffad1fa7344ae600144318b15dd46602b883cb995036
-  data.tar.gz: 85cb16a130a0d5084d43e4cc5c42e63df321bd2003d3f336f5626a4cbf63442bd98b67b1b5a328ae5e6241923ef22ca6577caa8f60bd26cb3da865ec36e8ff5f
+  metadata.gz: 6de84aa4b05b65507fd8c76a7ccd5272d1e7a73e1d70d6e63dce6d5f62b1c05c2bb70028f6126c1864909054b7e49f8a24369e1a360ff65e14978eb6f8f5a9bc
+  data.tar.gz: 3e08e22402d8223e3adc2863f7951ee009c678ef884d0a04d5f9d35e80128eb4cc9903388b534bb79d14225efece3a202164c3d6deeadf52155d27a394720d5c

data/README.md

@@ -25,54 +25,54 @@ Or install it yourself as:
 **Example**
 
     require 'nextcaller_client'
-    username = "XXXXX"
-    password = "YYYYY"
+    api_username = "XXXXX"
+    api_password = "YYYYY"
     phone_number = "121212..."
-    client = NextcallerClient::NextCallerClient.new(username, password)
+    client = NextcallerClient::NextCallerClient.new(api_username, api_password)
     resp = client.get_by_phone(phone_number)
     print resp
     
 **Initializing client**
 
     require 'nextcaller_client'
-    username = "XXXXX"
-    password = "YYYYY"
-    client = NextcallerClient::NextCallerClient.new(username, password)
+    api_username = "XXXXX"
+    api_password = "YYYYY"
+    client = NextcallerClient::NextCallerClient.new(api_username, api_password)
     
 **Get profile by phone**
 
-    resp = client.get_by_phone(phone, debug)
+    resp = client.get_by_phone(phone)
     
     # arguments:
     #   phone           -- 10 digits phone, str or int, required
-    #   debug           -- boolean (default false)
+
 
 **Get profile by id**
 
-    resp = client.get_by_profile_id(profile_id, debug)
+    resp = client.get_by_profile_id(profile_id)
     
     # arguments:
     #   profile_id      -- Profile identifier, required
-    #   debug           -- boolean (default false)
+
 
 **Update profile by id**
     
-    resp = client.update_by_profile_id(profile_id, data, debug)
+    resp = client.update_by_profile_id(profile_id, data)
     
     # arguments:
     #   profile_id      -- Profile identifier, required
     #   data            -- dictionary with changed data, required
-    #   debug           -- boolean (default false)
+
     
     # Returns 204 response in the case of the succesfull request.
 
 **Get fraud level**
 
-    resp = client.get_fraud_level(phone, debug)
+    resp = client.get_fraud_level(phone)
 
     # arguments:
     #   phone           -- 10 digits phone, str or int, required
-    #   debug           -- boolean (default false)
+
 
 
 ##Errors handling

data/examples/client_get_by_address_name.rb

@@ -0,0 +1,127 @@
+require 'nextcaller_client'
+
+api_username = 'XXXXX'
+api_password = 'XXXXX'
+sandbox = false
+address_data = {
+    'first_name' => 'Jerry',
+    'last_name' => 'Seinfeld',
+    'address' => '129 West 81st Street',
+    'city' => 'New York',
+    'state' => 'NY',
+    'zip_code' => '10024'
+}
+
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
+
+begin
+  response_content = client.get_by_name_address(address_data)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['records'][0]['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+
+#Hash
+# First name: Jerry
+# {
+#     "records" => [
+#         {
+#             "id" => "97d949a413f4ea8b85e9586e1f2d9a",
+#             "first_name" => "Jerry",
+#             "first_pronounced" => "JER-ee",
+#             "middle_name" => "Allen",
+#             "last_name" => "Seinfeld",
+#             "name" => "Jerry Allen Seinfeld",
+#             "language" => "English",
+#             "phone" => [
+#                 {
+#                     "number" => "2125558383",
+#                     "resource_uri" => "/v2/records/2125558383/"
+#                 }
+#             ],
+#             "address" => [
+#                 {
+#                     "city" => "New York",
+#                     "extended_zip" => "2344",
+#                     "country" => "USA",
+#                     "line1" => "129 West 81st Street",
+#                     "line2" => "Apt 5A",
+#                     "state" => "NY",
+#                     "zip_code" => "10024"
+#                 },
+#                 {
+#                     "city" => "New York",
+#                     "extended_zip" => "2345",
+#                     "country" => "USA",
+#                     "line1" => "129 West 81st Street",
+#                     "line2" => "Apt 5B",
+#                     "state" => "NY",
+#                     "zip_code" => "10024"
+#                 }
+#             ],
+#             "relatives" => [
+#                 {
+#                     "id" => "30400c6a0567b3a5168c9812ed617c",
+#                     "name" => "Morty Seinfeld",
+#                     "resource_uri" => "/v2/users/30400c6a0567b3a5168c9812ed617c/"
+#                 },
+#                 {
+#                     "id" => "6d342b76b2b9b00c63324a0d0fcca8",
+#                     "name" => "Helen Seinfeld",
+#                     "resource_uri" => "/v2/users/6d342b76b2b9b00c63324a0d0fcca8/"
+#                 }
+#             ],
+#             "email" => "jerry@example.org",
+#             "line_type" => "Mobile",
+#             "carrier" => "Verizon Wireless",
+#             "linked_emails" => [
+#                 "jerry@example.org",
+#                 "badman@example.org",
+#                 "domainmaster@example.org",
+#                 "hellooooooo@example.org",
+#                 "jaseinfeld@example.org",
+#                 "jerry_seinfeld@example.org",
+#                 "puffyshirt@example.org",
+#                 "seinfeld4@example.org"
+#             ],
+#             "social_links" => [
+#                 {
+#                     "type" => "twitter",
+#                     "url" => "https://twitter.com/jerryseinfeld",
+#                     "followers" => 26700
+#                 },
+#                 {
+#                     "type" => "facebook",
+#                     "url" => "https://www.facebook.com/JerrySeinfeld",
+#                     "followers" => 6584
+#                 },
+#                 {
+#                     "type" => "linkedin",
+#                     "url" => "https://www.linkedin.com/pub/jerry-seinfeld"
+#                 }
+#             ],
+#             "age" => "45-54",
+#             "education" => "Completed College",
+#             "gender" => "Male",
+#             "high_net_worth" => "Yes",
+#             "home_owner_status" => "Rent",
+#             "household_income" => "50k-75k",
+#             "length_of_residence" => "10 Years",
+#             "marital_status" => "Single",
+#             "market_value" => "500k-1mm",
+#             "occupation" => "White Collar Worker",
+#             "presence_of_children" => "No",
+#             "department" => "not specified",
+#             "telco_zip" => "0",
+#             "telco_zip_4" => "",
+#             "resource_uri" => "/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#         }
+#     ]
+# }
+#
+#

data/examples/client_get_by_email.rb

@@ -0,0 +1,57 @@
+require 'nextcaller_client'
+
+api_username = 'XXXXX'
+api_password = 'XXXXX'
+sandbox = false
+email = 'email@exmaple.com'
+
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
+
+begin
+  response_content = client.get_by_email(email)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['records'][0]['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+
+# Output:
+# Hash
+# First name: Jerry
+# {
+#   "records"=>[
+#     {
+#       "id"=>"97d949a413f4ea8b85e9586e1f2d9a", 
+#       "first_name"=>"Jerry", 
+#       "middle_name"=>"", 
+#       "last_name"=>"Seinfeld", 
+#       "name"=>"Jerry Seinfeld", 
+#       "language"=>"English", 
+#       "phone"=>[
+#         {
+#           "number"=>"2125558383", 
+#           "resource_uri"=>"/v2/records/2125558383/"
+#         }
+#       ], 
+#       "carrier"=>"Verizon Wireless", 
+#       "address"=>[
+#         {
+#           "city"=>"New York", 
+#           "extended_zip"=>"", 
+#           "country"=>"USA", 
+#           "line1"=>"129 West 81st Street", 
+#           "line2"=>"Apt 5a", 
+#           "state"=>"NY", 
+#           "zip_code"=>"10024"
+#         }
+#       ], 
+#       "line_type"=>"", 
+#       "department"=>"not specified", 
+#       "resource_uri"=>"/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#     }
+#   ]
+# }

data/examples/client_get_by_phone.rb

@@ -1,12 +1,11 @@
 require 'nextcaller_client'
 
-username = 'E72D42B98D2232703EE3'
-password = '826f22ade660d6612523b212b997094c70dba8e1'
-
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
 phone_number = '2125558383'
 
-client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
 
 begin
   response_content = client.get_by_phone(phone_number)
@@ -68,4 +67,4 @@ end
 #       "resource_uri": "/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
 #     }
 #   ]
-# }
+# }

data/examples/client_get_by_profile_id.rb

@@ -1,11 +1,11 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
 profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
 
-client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
 
 begin
   response_content = client.get_by_profile_id(profile_id)
@@ -18,6 +18,7 @@ rescue NextcallerClient::HttpException => error
   puts error.message
   puts error.content
 end
+
 # Output:
 # Hash
 # First name: Jerry

data/examples/client_get_fraud_level.rb

@@ -1,11 +1,11 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
 phone_number = '2125558383'
 
-client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
 
 begin
   response_content = client.get_fraud_level(phone_number)
@@ -18,10 +18,16 @@ rescue NextcallerClient::HttpException => error
   puts error.message
   puts error.content
 end
+
 # Output:
 # Hash
 # Fraud risk: medium
-# { 
-#   "fraud_risk"=>"medium", 
-#   "spoofed"=>"unknown"
-# }
+# {
+#   "created"=>1439237857,
+#   "created_iso"=>"2015-08-10T16:17:37.560719+00:00",
+#   "spoofed"=>"unknown",
+#   "ani"=>"12125558383",
+#   "fraud_risk"=>"medium",
+#   "cid"=>"unknown",
+#   "cid_blocked"=>"no"
+# }

data/examples/client_update_by_profile_id.rb

@@ -1,20 +1,17 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
 profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
 
-client = NextcallerClient::NextCallerClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
 
 begin
   data = { 
     first_name: "Clark",
     last_name:"Kent",
     email:"clarkkent@supermail.com",
-    phone1:"1234567890",
-    phone2:"2345678901",
-    phone3:"3456789012",
     shipping_address1:{
         line1:"223 Kryptonite Ave.",
         line2:"",

data/examples/platform_get_by_address_name.rb

@@ -0,0 +1,127 @@
+require 'nextcaller_client'
+
+api_username = 'XXXXX'
+api_password = 'XXXXX'
+sandbox = false
+address_data = {
+    'first_name' => 'Jerry',
+    'last_name' => 'Seinfeld',
+    'address' => '129 West 81st Street',
+    'city' => 'New York',
+    'state' => 'NY',
+    'zip_code' => '10024'
+}
+
+client = NextcallerClient::NextCallerClient.new(api_username, api_password, sandbox)
+
+begin
+  response_content = client.get_by_name_address(address_data)
+  puts response_content.class # Response is a hash
+  puts "First name: " + response_content['records'][0]['first_name'] # Retrieve first name for example
+  puts response_content
+rescue ArgumentError => error
+  puts error.message
+rescue NextcallerClient::HttpException => error
+  puts error.message
+  puts error.content
+end
+# Output:
+# Hash
+# First name: Jerry
+# {
+#     "records" => [
+#         {
+#             "id" => "97d949a413f4ea8b85e9586e1f2d9a",
+#             "first_name" => "Jerry",
+#             "first_pronounced" => "JER-ee",
+#             "middle_name" => "Allen",
+#             "last_name" => "Seinfeld",
+#             "name" => "Jerry Allen Seinfeld",
+#             "language" => "English",
+#             "phone" => [
+#                 {
+#                     "number" => "2125558383",
+#                     "resource_uri" => "/v2/records/2125558383/"
+#                 }
+#             ],
+#             "address" => [
+#                 {
+#                     "city" => "New York",
+#                     "extended_zip" => "2344",
+#                     "country" => "USA",
+#                     "line1" => "129 West 81st Street",
+#                     "line2" => "Apt 5A",
+#                     "state" => "NY",
+#                     "zip_code" => "10024"
+#                 },
+#                 {
+#                     "city" => "New York",
+#                     "extended_zip" => "2345",
+#                     "country" => "USA",
+#                     "line1" => "129 West 81st Street",
+#                     "line2" => "Apt 5B",
+#                     "state" => "NY",
+#                     "zip_code" => "10024"
+#                 }
+#             ],
+#             "relatives" => [
+#                 {
+#                     "id" => "30400c6a0567b3a5168c9812ed617c",
+#                     "name" => "Morty Seinfeld",
+#                     "resource_uri" => "/v2/users/30400c6a0567b3a5168c9812ed617c/"
+#                 },
+#                 {
+#                     "id" => "6d342b76b2b9b00c63324a0d0fcca8",
+#                     "name" => "Helen Seinfeld",
+#                     "resource_uri" => "/v2/users/6d342b76b2b9b00c63324a0d0fcca8/"
+#                 }
+#             ],
+#             "email" => "jerry@example.org",
+#             "line_type" => "Mobile",
+#             "carrier" => "Verizon Wireless",
+#             "linked_emails" => [
+#                 "jerry@example.org",
+#                 "badman@example.org",
+#                 "domainmaster@example.org",
+#                 "hellooooooo@example.org",
+#                 "jaseinfeld@example.org",
+#                 "jerry_seinfeld@example.org",
+#                 "puffyshirt@example.org",
+#                 "seinfeld4@example.org"
+#             ],
+#             "social_links" => [
+#                 {
+#                     "type" => "twitter",
+#                     "url" => "https://twitter.com/jerryseinfeld",
+#                     "followers" => 26700
+#                 },
+#                 {
+#                     "type" => "facebook",
+#                     "url" => "https://www.facebook.com/JerrySeinfeld",
+#                     "followers" => 6584
+#                 },
+#                 {
+#                     "type" => "linkedin",
+#                     "url" => "https://www.linkedin.com/pub/jerry-seinfeld"
+#                 }
+#             ],
+#             "age" => "45-54",
+#             "education" => "Completed College",
+#             "gender" => "Male",
+#             "high_net_worth" => "Yes",
+#             "home_owner_status" => "Rent",
+#             "household_income" => "50k-75k",
+#             "length_of_residence" => "10 Years",
+#             "marital_status" => "Single",
+#             "market_value" => "500k-1mm",
+#             "occupation" => "White Collar Worker",
+#             "presence_of_children" => "No",
+#             "department" => "not specified",
+#             "telco_zip" => "0",
+#             "telco_zip_4" => "",
+#             "resource_uri" => "/v2/users/97d949a413f4ea8b85e9586e1f2d9a/"
+#         }
+#     ]
+# }
+#
+#