persona_api 0.1.7 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7d308b88c311b3deeeb677d3b6a47678e57cee228f94c4c26cad6fe539ac294
-  data.tar.gz: d80c4955d35e0c64b4b8ceefae37a9c9f0e3665bf90bf0d963e1b6048ccdb14b
+  metadata.gz: cc142f2d3d4b1ea4f61b57a549b47c1589ec6235b758f79dfc9a7425fce30d7e
+  data.tar.gz: c5f2530ffc6c82964cea5bdbd1a70fd94d6f58872330900c2c0ab9570c2c4f1f
 SHA512:
-  metadata.gz: c16adba0eb78c7bd84d4cbcdcee671821b25f8e950835d3c418f9ecf5d449a32fe765837f180fb16ed75db2a6b5f4ae1b4dcb3b4fbc2a0db9f1632551265e7b3
-  data.tar.gz: 5c72a21cb1a404909ab91b44256d68085987a94dfc3e73569a401bf4cbeec1421005189cd373629090ee131138af1a4e8dfb05c8f7bc6d42d5fdd49de2bbb03e
+  metadata.gz: b3dfb21662215e270f42b6e7c76e271fdd3795f132411ec7af9f419743204444c2bcee1412bccb420047150adce0bb1e2c63e9df46c0855ad78a4cd3b348b6c5
+  data.tar.gz: a090952568e4010bf393b609b44e47971fe3bf5ef3af2fb5c3dd297e8a7e24190d00a79bea91a41b1525c23e7eeed7068ab360aaf6e4e9620847d4c1e6314d77

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+== [0.2.0] - 2022-08-18
+
+* Update README.md
+* Add Server API Verification Endpoints (Gov ID, Phone, Database, TIN)
+* Bug fixes
+
 == [0.1.7] - 2022-07-16
 
 * Update README.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    persona_api (0.1.5)
+    persona_api (0.1.7)
       faraday (~> 1.7)
       faraday_middleware (~> 1.1)
 

data/README.md

@@ -18,7 +18,7 @@ Or install it yourself with:
 
 ## Usage
 
-To access the API, you'll need to create a `PersonaAPI::Client` and pass in your API key. You can find your API key in your [Persona dashboard](https://app.withpersona.com/dashboard/api-configuration).
+To access the API, you'll need to create a `PersonaApi::Client` and pass in your API key. You can find your API key in your [Persona dashboard](https://app.withpersona.com/dashboard/api-configuration).
 
 ```ruby
 client = PersonaApi::Client.new(api_key: ENV["PERSONA_API_KEY"])
@@ -29,7 +29,7 @@ The client then gives you access to all of the resources.
 
 The gem attempts to map as closely as possible to the Persona API so that you can easily convert API examples in to gem code.
 
-Responses are (in *almost* all cases) created as Objects like `PersonaAPI::Account`. Having types like `PersonaAPI::Inquiry` is useful for understanding the type of object you're working with. They're built using OpenStruct so that data is easily accessible in a Rubyish way.
+Responses are (in *almost* all cases) created as Objects like `PersonaApi::Account`. Having types like `PersonaApi::Inquiry` is useful for understanding the type of object you're working with. They're built using OpenStruct so that data is easily accessible in a Rubyish way.
 
 ##### Pagination
 
@@ -37,17 +37,17 @@ Responses are (in *almost* all cases) created as Objects like `PersonaAPI::Accou
 
 ```ruby
 results = client.inquiries.list("page[size]": 5)
-#=> PersonaAPI::Collection
+#=> PersonaApi::Collection
 
 results.data
-#=> [#<PersonaAPI::Inquiry>, #<PersonaAPI::Inquiry>]
+#=> [#<PersonaApi::Inquiry>, #<PersonaApi::Inquiry>]
 
 results.next_page
 #=> "inq_NiHBQW47WfdPT58m4VcqFebx"
 
 # Retrieve the next page
 client.inquiries.list("page[size]": 5, "page[after]": results.next_page)
-#=> PersonaAPI::Collection
+#=> PersonaApi::Collection
 ```
 
 ### Accounts
@@ -81,6 +81,14 @@ client.cases.set_status(case_id: "id", {})
 client.cases.add_persona_objects(case_id: "id", {})
 ```
 
+### Database Verifications
+
+```ruby
+client.database_verifications.create({})
+client.database_verifications.retrieve(ver_id: "id")
+client.database_verifications.submit(ver_id: "id", {})
+```
+
 ### Documents
 
 ```ruby
@@ -100,6 +108,14 @@ client.events.retrive(evt_id:)
 client.files.download(file_id:, file_name:)
 ```
 
+### Government ID Verifications
+
+```ruby
+client.government_id_verifications.create({})
+client.government_id_verifications.retrieve(ver_id: "id")
+client.government_id_verifications.submit(ver_id: "id", {})
+```
+
 ### Inquiries
 
 ```ruby
@@ -134,6 +150,29 @@ client.lists.create_name_list({})
 client.lists.create_phone_number_list({})
 ```
 
+### List Items
+
+```ruby
+
+```
+
+### Phone Carrier Verifications
+
+```ruby
+client.phone_carrier_verifications.create({})
+client.phone_carrier_verifications.retrieve(ver_id: "id")
+client.phone_carrier_verifications.submit(ver_id: "id", {})
+```
+
+### Phone Number Verifications
+
+```ruby
+client.phone_number_verifications.create({})
+client.phone_number_verifications.retrieve(ver_id: "id")
+client.phone_number_verifications.send_sms(ver_id: "id", {})
+client.phone_number_verifications.confirm(ver_id: "id", {})
+```
+
 ### Reports
 
 ```ruby
@@ -147,6 +186,14 @@ client.reports.remove_tag(rep_id: "id", {})
 client.reports.set_all_tags(rep_id: "id", {})
 ```
 
+### TIN Database Verifications
+
+```ruby
+client.tin_database_verifications.create({})
+client.tin_database_verifications.retrieve(ver_id: "id")
+client.tin_database_verifications.submit(ver_id: "id", {})
+```
+
 ### User Audit Logs
 
 ```ruby

data/lib/persona_api/client.rb

@@ -24,6 +24,10 @@ module PersonaApi
       CasesResource.new(self)
     end
 
+    def database_verifications
+      DatabaseVerificationsResource.new(self)
+    end
+
     def documents
       DocumentsResource.new(self)
     end
@@ -32,6 +36,14 @@ module PersonaApi
       EventsResource.new(self)
     end
 
+    def files
+      FilesResource.new(self)
+    end
+
+    def government_id_verifications
+      GovernmentIdVerificationsResource.new(self)
+    end
+
     def inquiries
       InquiriesResource.new(self)
     end
@@ -44,10 +56,22 @@ module PersonaApi
       ListItemsResource.new(self)
     end
 
+    def phone_carrier_verifications
+      PhoneCarrierVerificationsResource.new(self)
+    end
+
+    def phone_number_verifications
+      PhoneNumberVerificationsResource.new(self)
+    end
+
     def reports
       ReportsResource.new(self)
     end
 
+    def tin_database_verifications
+      TinDatabaseVerificationsResource.new(self)
+    end
+
     def user_audit_logs
       UserAuditLogsResource.new(self)
     end

data/lib/persona_api/objects/database_verification.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class DatabaseVerification < Object
+  end
+end

data/lib/persona_api/objects/government_id_verification.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class GovernmentIdVerification < Object
+  end
+end

data/lib/persona_api/objects/phone_carrier_verification.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class PhoneCarrierVerification < Object
+  end
+end

data/lib/persona_api/objects/phone_number_verification.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class PhoneNumberVerification < Object
+  end
+end

data/lib/persona_api/objects/tin_database_verification.rb

@@ -0,0 +1,4 @@
+module PersonaApi
+  class TinDatabaseVerification < Object
+  end
+end

data/lib/persona_api/resources/database_verifications.rb

@@ -0,0 +1,17 @@
+module PersonaApi
+  class DatabaseVerificationsResource < Resource
+    def create(**attributes)
+      # Database attributes must include a 'verification-template-id' and 'country-code' as well as other fields as laid out
+      # in the documentation https://docs.withpersona.com/reference/create-a-database-verification
+      DatabaseVerification.new post_request("verification/databases", body: attributes).body.dig("data")
+    end
+
+    def retrieve(ver_id:)
+      DatabaseVerification.new get_request("verification/databases/#{ver_id}").body.dig("data")
+    end
+
+    def submit(ver_id:, **attributes)
+      DatabaseVerification.new post_request("verification/databases/#{ver_id}/submit", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/government_id_verifications.rb

@@ -0,0 +1,17 @@
+module PersonaApi
+  class GovernmentIdVerificationsResource < Resource
+    def create(**attributes)
+      # Gov ID attributes must include a 'verification-template-id' as well as other fields as laid out
+      # in the documentation https://docs.withpersona.com/reference/create-a-government-id-verification
+      GovernmentIdVerification.new post_request("verification/government-ids", body: attributes).body.dig("data")
+    end
+
+    def retrieve(ver_id:)
+      GovernmentIdVerification.new get_request("verification/government-ids/#{ver_id}").body.dig("data")
+    end
+
+    def submit(ver_id:, **attributes)
+      GovernmentIdVerification.new post_request("verification/government-ids/#{ver_id}/submit", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/phone_carrier_verifications.rb

@@ -0,0 +1,17 @@
+module PersonaApi
+  class PhoneCarrierVerificationsResource < Resource
+    def create(**attributes)
+      # Database attributes must include a 'verification-template-id' as well as other fields as laid out
+      # in the documentation https://docs.withpersona.com/reference/create-a-phone-carrier-database-verification
+      PhoneCarrierVerification.new post_request("verification/database-phone-carriers", body: attributes).body.dig("data")
+    end
+
+    def retrieve(ver_id:)
+      PhoneCarrierVerification.new get_request("verification/database-phone-carriers/#{ver_id}").body.dig("data")
+    end
+
+    def submit(ver_id:, **attributes)
+      PhoneCarrierVerification.new post_request("verification/database-phone-carriers/#{ver_id}/submit", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/phone_number_verifications.rb

@@ -0,0 +1,21 @@
+module PersonaApi
+  class PhoneNumberVerificationsResource < Resource
+    def confirm(ver_id:, **attributes)
+      PhoneNumberVerification.new post_request("verification/phone-numbers/#{ver_id}/confirm", body: attributes).body.dig("data")
+    end
+
+    def create(**attributes)
+      # Phone number attributes must include a 'verification-template-id', 'phone-number' and 'country-code' as well
+      # as other fields as laid out in the documentation https://docs.withpersona.com/reference/create-a-phone-number-verification
+      PhoneNumberVerification.new post_request("verification/phone-numbers", body: attributes).body.dig("data")
+    end
+
+    def retrieve(ver_id:)
+      PhoneNumberVerification.new get_request("verification/phone-numbers/#{ver_id}").body.dig("data")
+    end
+
+    def send_sms(ver_id:, **attributes)
+      PhoneNumberVerification.new post_request("verification/phone-numbers/#{ver_id}/send-confirmation-code", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/resources/tin_database_verifications.rb

@@ -0,0 +1,17 @@
+module PersonaApi
+  class TinDatabaseVerificationsResource < Resource
+    def create(**attributes)
+      # TIN Database attributes must include a 'verification-template-id', a 'tin' as well as other fields as laid out
+      # in the documentation https://docs.withpersona.com/reference/create-a-tin-database-verification
+      TinDatabaseVerification.new post_request("verification/database-tins", body: attributes).body.dig("data")
+    end
+
+    def retrieve(ver_id:)
+      TinDatabaseVerification.new get_request("verification/database-tins/#{ver_id}").body.dig("data")
+    end
+
+    def submit(ver_id:, **attributes)
+      TinDatabaseVerification.new post_request("verification/database-tins/#{ver_id}/submit", body: attributes).body.dig("data")
+    end
+  end
+end

data/lib/persona_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PersonaApi
-  VERSION = "0.1.7"
+  VERSION = "0.2.0"
 end

data/lib/persona_api.rb

@@ -22,6 +22,11 @@ module PersonaApi
   autoload :ApiLog, "persona_api/objects/api_log"
   autoload :UserAuditLog, "persona_api/objects/user_audit_log"
   autoload :ListItem, "persona_api/objects/list_item"
+  autoload :GovernmentIdVerification, "persona_api/objects/government_id_verification"
+  autoload :DatabaseVerification, "persona_api/objects/database_verification"
+  autoload :PhoneNumberVerification, "persona_api/objects/phone_number_verification"
+  autoload :PhoneCarrierVerification, "persona_api/objects/phone_carrier_verification"
+  autoload :TinDatabaseVerification, "persona_api/objects/tin_database_verification"
 
   # resources
   autoload :AccountsResource, "persona_api/resources/accounts"
@@ -35,5 +40,10 @@ module PersonaApi
   autoload :ListsResource, "persona_api/resources/lists"
   autoload :ApiLogsResource, "persona_api/resources/api_logs"
   autoload :UserAuditLogsResource, "persona_api/resources/user_audit_logs"
-  autoload :ListItemsResource, "persona_api/resoruces/list_items"
+  autoload :ListItemsResource, "persona_api/resources/list_items"
+  autoload :GovernmentIdVerificationsResource, "persona_api/resources/government_id_verifications"
+  autoload :DatabaseVerificationsResource, "persona_api/resources/database_verifications"
+  autoload :PhoneNumberVerificationsResource, "persona_api/resources/phone_number_verifications"
+  autoload :PhoneCarrierVerificationsResource, "persona_api/resources/phone_carrier_verifications"
+  autoload :TinDatabaseVerificationsResource, "persona_api/resources/tin_database_verifications"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: persona_api
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Griffith
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-07-16 00:00:00.000000000 Z
+date: 2022-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -61,30 +61,39 @@ files:
 - lib/persona_api/objects/account.rb
 - lib/persona_api/objects/api_log.rb
 - lib/persona_api/objects/case.rb
+- lib/persona_api/objects/database_verification.rb
 - lib/persona_api/objects/document.rb
 - lib/persona_api/objects/event.rb
 - lib/persona_api/objects/file.rb
+- lib/persona_api/objects/government_id_verification.rb
 - lib/persona_api/objects/inquiry.rb
 - lib/persona_api/objects/list.rb
 - lib/persona_api/objects/list_item.rb
+- lib/persona_api/objects/phone_carrier_verification.rb
+- lib/persona_api/objects/phone_number_verification.rb
 - lib/persona_api/objects/report.rb
+- lib/persona_api/objects/tin_database_verification.rb
 - lib/persona_api/objects/user_audit_log.rb
 - lib/persona_api/objects/verification.rb
 - lib/persona_api/resource.rb
 - lib/persona_api/resources/accounts.rb
 - lib/persona_api/resources/api_logs.rb
 - lib/persona_api/resources/cases.rb
+- lib/persona_api/resources/database_verifications.rb
 - lib/persona_api/resources/documents.rb
 - lib/persona_api/resources/events.rb
 - lib/persona_api/resources/files.rb
+- lib/persona_api/resources/government_id_verifications.rb
 - lib/persona_api/resources/inquiries.rb
 - lib/persona_api/resources/list_items.rb
 - lib/persona_api/resources/lists.rb
+- lib/persona_api/resources/phone_carrier_verifications.rb
+- lib/persona_api/resources/phone_number_verifications.rb
 - lib/persona_api/resources/reports.rb
+- lib/persona_api/resources/tin_database_verifications.rb
 - lib/persona_api/resources/user_audit_logs.rb
 - lib/persona_api/resources/verifications.rb
 - lib/persona_api/version.rb
-- persona_api-0.1.6.gem
 - sig/persona_api.rbs
 homepage: https://github.com/mattgriffith0/persona_api
 licenses: