nextcaller_client 0.0.3 → 0.0.4

data/examples/platform_get_by_email.rb

@@ -0,0 +1,57 @@
+require 'nextcaller_client'
+
+api_username = 'XXXXX'
+api_password = 'XXXXX'
+sandbox = false
+account_id = 'user12345'
+email = 'email@exmaple.com'
+
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
+
+begin
+  response_content = client.get_by_email(email, account_id)
+  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/platform_get_by_phone.rb

@@ -1,15 +1,15 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
-platform_username = 'user12345'
+account_id = 'user12345'
 phone_number = '2125558383'
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
-  response_content = client.get_by_phone(phone_number, platform_username)
+  response_content = client.get_by_phone(phone_number, account_id)
   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

data/examples/platform_get_by_profile_id.rb

@@ -1,15 +1,15 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
-platform_username = 'user12345'
+account_id = 'user12345'
 profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
-  response_content = client.get_by_profile_id(profile_id, platform_username)
+  response_content = client.get_by_profile_id(profile_id, account_id)
   puts response_content.class # Response is a hash
   puts "First name: " + response_content['first_name'] # Retrieve first name for example
   puts response_content

data/examples/platform_get_fraud_level.rb

@@ -1,15 +1,15 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
-platform_username = 'user12345'
+account_id = 'user12345'
 phone_number = '2125558383'
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
-  response_content = client.get_fraud_level(phone_number, platform_username)
+  response_content = client.get_fraud_level(phone_number, account_id)
   puts response_content.class # Response is a hash
   puts "Fraud risk: " + response_content['fraud_risk'] # Retrieve fraud risk for example
   puts response_content

data/examples/platform_get_statistics.rb

@@ -1,15 +1,15 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
   response_content = client.get_platform_statistics
   puts response_content.class # Response is a hash
-  puts "Platform name: " + response_content['object_list'][0]['username'] # Retrieve platform name for example
+  puts "Platform name: " + response_content['data'][0]['id'] # Retrieve platform name for example
   puts response_content
 rescue ArgumentError => error
   puts error.message

data/examples/platform_get_user.rb

@@ -1,14 +1,14 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
-platform_username = 'user12345'
+account_id = 'user12345'
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
-  response_content = client.get_platform_user(platform_username)
+  response_content = client.get_platform_account(account_id)
   puts response_content.class # Response is a hash
   puts "First name: " + response_content['first_name'] # Retrieve first name for example
   puts response_content

data/examples/platform_update_by_profile_id.rb

@@ -1,16 +1,16 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
 profile_id = '97d949a413f4ea8b85e9586e1f2d9a'
-platform_username = 'user12345'
+account_id = 'user12345'
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
   data = { email: 'test@test.com' } 
-  response = client.update_by_profile_id(profile_id, platform_username, data)
+  response = client.update_by_profile_id(profile_id, account_id, data)
   puts response.class # Response is a object of Net::HTTPNoContent
   puts 'Success'
 rescue ArgumentError => error

data/examples/platform_update_platform_user.rb

@@ -1,15 +1,15 @@
 require 'nextcaller_client'
 
-username = 'XXXXX'
-password = 'XXXXX'
+api_username = 'XXXXX'
+api_password = 'XXXXX'
 sandbox = false
-platform_username = 'user12345'
+account_id = 'user12345'
 
-client = NextcallerClient::NextCallerPlatformClient.new(username, password, sandbox)
+client = NextcallerClient::NextCallerPlatformClient.new(api_username, api_password, sandbox)
 
 begin
   data = { email: 'test@test.com' } 
-  response = client.update_platform_user(platform_username, data)
+  response = client.update_platform_user(account_id, data)
   puts response.class # Response is a object of Net::HTTPNoContent
   puts 'Success'
 rescue ArgumentError => error

data/lib/nextcaller_client/client.rb

@@ -13,16 +13,14 @@ module NextcallerClient
     # Get profiles by phone
     # arguments:
     #   phone           -- 10 digits phone, str ot int, required
-    #   debug           -- boolean (default false)
     #
-    def get_by_phone(phone, debug=false)
-      Utils.validate_phone(phone)
+    def get_by_phone(phone)
       url_params = {
         phone: phone,
         format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('records/', @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      response = @transport.make_http_request(url, 'GET')
 
       block_given? ? yield(response) : JSON.parse(response.body)
     end
@@ -30,33 +28,59 @@ module NextcallerClient
     # Get profile by id
     # arguments:
     #   profile_id      -- Profile identifier, required, length is 30
-    #   debug           -- boolean (default false)
     #
-    def get_by_profile_id(profile_id, debug=false)
-      Utils.validate_profile_id(profile_id)
+    def get_by_profile_id(profile_id)
       url_params = {
-        format: JSON_RESPONSE_FORMAT
+          format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      response = @transport.make_http_request(url, 'GET')
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get profile by name and address
+    # arguments:
+    #   data                -- dictionary with changed data, required
+    #
+    def get_by_name_address(name_address_data)
+      url_params = {
+          format: JSON_RESPONSE_FORMAT
+      }.merge(name_address_data)
+      url = Utils.prepare_url('records/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET')
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get profile by email
+    # arguments:
+    #   email      -- Email, required, str, length is 30
+    #
+    def get_by_email(email)
+      url_params = {
+          email: email,
+          format: JSON_RESPONSE_FORMAT,
+      }
+      url = Utils.prepare_url('records/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET')
 
       block_given? ? yield(response) : JSON.parse(response.body)
     end
 
+
     # Update profile by id
     # arguments:
     #   profile_id      -- Profile identifier, required, length is 30
     #   data            -- dictionary with changed data, required
-    #   debug           -- boolean (default false)
     #
-    def update_by_profile_id(profile_id, data, debug=false)
-      Utils.validate_profile_id(profile_id)
+    def update_by_profile_id(profile_id, data)
       url_params = {
         format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
       data = Utils.prepare_json_data(data)
-      response = @transport.make_http_request(url, 'POST', debug, data)
+      response = @transport.make_http_request(url, 'POST', data)
 
       block_given? ? yield(response) : response
     end
@@ -64,16 +88,14 @@ module NextcallerClient
     # Get fraud level for phone
     # arguments:
     #   phone           -- 10 digits phone, str ot int, required
-    #   debug           -- boolean (default false)
     #
-    def get_fraud_level(phone, debug=false)
-      Utils.validate_phone(phone)
+    def get_fraud_level(phone)
       url_params = {
         phone: phone,
         format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('fraud/', @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      response = @transport.make_http_request(url, 'GET')
 
       block_given? ? yield(response) : JSON.parse(response.body)
     end
@@ -87,19 +109,15 @@ module NextcallerClient
     # Get profiles by phone
     # arguments:
     #   phone               -- 10 digits phone, str ot int, required
-    #   platform_username   -- platform username, str.
-    #   debug               -- boolean (default false)
+    #   account_id   -- platform username, str.
     #
-    def get_by_phone(phone, platform_username, debug=false)
-      Utils.validate_phone(phone)
-      Utils.validate_platform_username(platform_username)
+    def get_by_phone(phone, account_id=DEFAULT_PLATFORM_ACCOUNT_ID)
       url_params = {
         phone: phone,
-        platform_username: platform_username, 
         format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('records/', @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      response = @transport.make_http_request(url, 'GET',  account_id)
 
       block_given? ? yield(response) : JSON.parse(response.body)
     end
@@ -107,18 +125,44 @@ module NextcallerClient
     # Get profiles by phone
     # arguments:
     #   profile_id          -- Profile identifier, required, length is 30
-    #   platform_username   -- platform username, str.
-    #   debug               -- boolean (default false)
+    #   account_id   -- platform username, str.
     #
-    def get_by_profile_id(profile_id, platform_username, debug=false)
-      Utils.validate_profile_id(profile_id)
-      Utils.validate_platform_username(platform_username)
+    def get_by_profile_id(profile_id, account_id=DEFAULT_PLATFORM_ACCOUNT_ID)
       url_params = {
-        platform_username: platform_username,
-        format: JSON_RESPONSE_FORMAT        
+        format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      response = @transport.make_http_request(url, 'GET', account_id)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get profile by name and address
+    # arguments:
+    #   data                -- dictionary with changed data, required
+    #   account_id   -- platform username, str.
+    #
+    def get_by_name_address(name_address_data, account_id)
+      url_params = {
+          format: JSON_RESPONSE_FORMAT
+      }.merge(name_address_data)
+      url = Utils.prepare_url('records/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET',  account_id)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
+    # Get profile by email
+    # arguments:
+    #   email      -- Email, required, str, length is 30
+    #
+    def get_by_email(email, account_id=DEFAULT_PLATFORM_ACCOUNT_ID)
+      url_params = {
+          format: JSON_RESPONSE_FORMAT,
+          email: email
+      }
+      url = Utils.prepare_url('records/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET',  account_id)
 
       block_given? ? yield(response) : JSON.parse(response.body)
     end
@@ -127,91 +171,97 @@ module NextcallerClient
     # arguments:
     #   profile_id          -- Profile identifier, required, length is 30
     #   data                -- dictionary with changed data, required
-    #   platform_username   -- platform username, str.
-    #   debug               -- boolean (default false)
+    #   account_id   -- platform username, str.
     #
-    def update_by_profile_id(profile_id, platform_username, data, debug=false)
-      Utils.validate_profile_id(profile_id)
-      Utils.validate_platform_username(platform_username)
+    def update_by_profile_id(profile_id, account_id=DEFAULT_PLATFORM_ACCOUNT_ID, data)
       url_params = {
-        platform_username: platform_username, 
         format: JSON_RESPONSE_FORMAT
       }
       url = Utils.prepare_url('users/%s/' % profile_id, @sandbox, url_params)
       data = Utils.prepare_json_data(data)
-      response = @transport.make_http_request(url, 'POST', debug, data)
+      response = @transport.make_http_request(url, 'POST', data,  account_id)
 
       block_given? ? yield(response) : response
     end
 
-    # Get profiles by phone
+    # Get platform statistics
     # arguments:
-    #   phone               -- 10 digits phone, str ot int, required
-    #   data                -- dictionary with changed data, required
-    #   platform_username   -- platform username, str.
-    #   debug               -- boolean (default false)
+    #   page               -- integer (default 1)
     #
-    def get_fraud_level(phone, platform_username, debug=false)
-      Utils.validate_phone(phone)
-      Utils.validate_platform_username(platform_username)
+    def get_platform_statistics(page=1)
       url_params = {
-        platform_username: platform_username,
-        phone: phone,
-        format: JSON_RESPONSE_FORMAT
+          page: page,
+          format: JSON_RESPONSE_FORMAT,
       }
-      url = Utils.prepare_url('fraud/', @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
-
+      url = Utils.prepare_url('accounts/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET')
+      puts response.body
       block_given? ? yield(response) : JSON.parse(response.body)
     end
 
-    # Get platform statistics
+    # Get platform user
     # arguments:
-    #   debug               -- boolean (default false)
+    #   account_id   -- platform username, str.
     #
-    def get_platform_statistics(debug=false)
+    def get_platform_account(account_id=DEFAULT_PLATFORM_ACCOUNT_ID)
       url_params = {
-        format: JSON_RESPONSE_FORMAT
+          format: JSON_RESPONSE_FORMAT
       }
-      url = Utils.prepare_url('platform_users/', @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      url = Utils.prepare_url('accounts/%s/' % account_id, @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET')
 
       block_given? ? yield(response) : JSON.parse(response.body)
     end
 
-    # Get platform user
+    # Create platform account
     # arguments:
-    #   platform_username   -- platform username, str.
-    #   debug               -- boolean (default false)
+    #   data                -- dictionary with changed data, required
     #
-    def get_platform_user(platform_username, debug=false)
-      Utils.validate_platform_username(platform_username)
+    def create_platform_account(data)
       url_params = {
-        format: JSON_RESPONSE_FORMAT
+          format: JSON_RESPONSE_FORMAT
       }
-      url = Utils.prepare_url('platform_users/%s/' % platform_username, @sandbox, url_params)
-      response = @transport.make_http_request(url, 'GET', debug)
+      url = Utils.prepare_url('accounts/', @sandbox, url_params)
+      data = Utils.prepare_json_data(data)
+      response = @transport.make_http_request(url, 'POST', data)
 
-      block_given? ? yield(response) : JSON.parse(response.body)
+      block_given? ? yield(response) : response
     end
 
     # Update platform user data
     # arguments:
-    #   platform_username   -- platform username, str.
+    #   account_id   -- platform username, str.
     #   data                -- dictionary with changed data, required
-    #   debug               -- boolean (default false)
     #
-    def update_platform_user(platform_username, data, debug=false)
-      Utils.validate_platform_username(platform_username)
+    def update_platform_account(account_data, account_id)
       url_params = {
-        format: JSON_RESPONSE_FORMAT
+          format: JSON_RESPONSE_FORMAT
       }
-      url = Utils.prepare_url('platform_users/%s/' % platform_username, @sandbox, url_params)
-      data = Utils.prepare_json_data(data)
-      response = @transport.make_http_request(url, 'POST', debug, data)
+      url = Utils.prepare_url('accounts/%s/' % account_id, @sandbox, url_params)
+      data = Utils.prepare_json_data(account_data)
+      response = @transport.make_http_request(url, 'POST', data)
 
       block_given? ? yield(response) : response
-    end  
+    end
+
+
+    # Get profiles by phone
+    # arguments:
+    #   phone               -- 10 digits phone, str ot int, required
+    #   data                -- dictionary with changed data, required
+    #   account_id   -- platform username, str.
+    #
+    def get_fraud_level(phone, account_id=DEFAULT_PLATFORM_ACCOUNT_ID)
+      url_params = {
+        phone: phone,
+        format: JSON_RESPONSE_FORMAT
+      }
+      url = Utils.prepare_url('fraud/', @sandbox, url_params)
+      response = @transport.make_http_request(url, 'GET',  account_id)
+
+      block_given? ? yield(response) : JSON.parse(response.body)
+    end
+
 
   end