active_call-doc_fox 0.1.2 → 0.2.0

data/lib/doc_fox/evidence_submission/reject_service.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+class DocFox::EvidenceSubmission::RejectService < DocFox::BaseService
+  attr_reader :id, :reason
+
+  validates :id, :reason, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, reason:)
+    @id     = id
+    @reason = reason
+  end
+
+  # Reject an active evidence submission.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1reject/patch
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::EvidenceSubmission::RejectService.call(id: '', reason: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::EvidenceSubmission::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # PATCH /api/v2/kyc_applications/:id/archive
+  def call
+    connection.patch("evidence_submissions/#{id}/reject", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type:       'evidence_submission',
+        id:         id,
+        attributes: {
+          rejection_reason: reason
+        }
+      }
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::EvidenceSubmission::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/evidence_submission/replace_service.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+class DocFox::EvidenceSubmission::ReplaceService < DocFox::BaseService
+  attr_reader :id
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:)
+    @id = id
+  end
+
+  # Approve an active evidence submission.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D~1replace/patch
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::EvidenceSubmission::ReplaceService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::EvidenceSubmission::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # PATCH /api/v2/kyc_applications/:id/replace
+  def call
+    connection.patch("evidence_submissions/#{id}/replace", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: {
+        type: 'evidence_submission',
+        id:   id
+      }
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::EvidenceSubmission::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/evidence_submission/update_service.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+class DocFox::EvidenceSubmission::UpdateService < DocFox::BaseService
+  attr_reader :id, :data
+
+  validates :id, :data, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, data:)
+    @id   = id
+    @data = data
+  end
+
+  # Update an evidence submission.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Evidence-Submissions/paths/~1api~1v2~1evidence_submissions~1%7Bevidence_submission_id%7D/patch
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::EvidenceSubmission::UpdateService.call(
+  #     id: '',
+  #     data: {
+  #       type: 'evidence_submission',
+  #       id: '',
+  #       attributes: {
+  #         results: {
+  #           dob: '1984-01-01',
+  #           gender: 'M',
+  #           surname: 'Cartman',
+  #           forename1: 'Eric',
+  #           forename2: nil,
+  #           id_number: '8401017223183',
+  #           addresses: {
+  #             address: [
+  #               {
+  #                 addr_type: 'R',
+  #                 addr_line1: '28201 E. Bonanza St.',
+  #                 addr_line2: '',
+  #                 addr_line3: '',
+  #                 addr_line4: 'South Park',
+  #                 addr_postal_code: '8000',
+  #                 addr_update_date: '2017-11-21'
+  #               }
+  #             ]
+  #           },
+  #           telephones: {
+  #             telephone: [
+  #               {
+  #                 tel_num: '27715555555',
+  #                 tel_type: 'Cell',
+  #                 tel_update_date: '2017-09-05'
+  #               }
+  #             ]
+  #           },
+  #           deceased_date: nil,
+  #           deceased_flag: 'N',
+  #           verified_date: '2015-06-23',
+  #           verified_flag: 'Y',
+  #           deceased_reason: nil
+  #         }
+  #       }
+  #     }
+  #   )
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::EvidenceSubmission::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  # PATCH /api/v2/evidence_submissions/:id
+  def call
+    connection.patch("evidence_submissions/#{id}", **params)
+  end
+
+  private
+
+  def params
+    {
+      data: data
+    }
+  end
+
+  def set_facade
+    @facade = DocFox::EvidenceSubmission::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/kyc_application/approve_service.rb

@@ -15,6 +15,8 @@ class DocFox::KycApplication::ApproveService < DocFox::BaseService
 
   # Approve a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1approve/patch
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::ApproveService.call(id: '')

data/lib/doc_fox/kyc_application/archive_service.rb

@@ -12,6 +12,8 @@ class DocFox::KycApplication::ArchiveService < DocFox::BaseService
 
   # Archive a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1archive/post
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::ArchiveService.call(id: '', reason: '')

data/lib/doc_fox/kyc_application/create_service.rb

@@ -15,6 +15,8 @@ class DocFox::KycApplication::CreateService < DocFox::BaseService
 
   # Create a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications/post
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::CreateService.call(

data/lib/doc_fox/kyc_application/delete_service.rb

@@ -11,6 +11,8 @@ class DocFox::KycApplication::DeleteService < DocFox::BaseService
 
   # Delete a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D/delete
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::DeleteService.call(id: '')

data/lib/doc_fox/kyc_application/get_service.rb

@@ -16,6 +16,8 @@ class DocFox::KycApplication::GetService < DocFox::BaseService
 
   # Get a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D/get
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::GetService.call(id: '')
@@ -41,7 +43,7 @@ class DocFox::KycApplication::GetService < DocFox::BaseService
   #
   # GET /api/v2/kyc_applications/:id
   def call
-    connection.get("kyc_applications/#{id}", params)
+    connection.get("kyc_applications/#{id}", **params)
   end
 
   private

data/lib/doc_fox/kyc_application/list_service.rb

@@ -7,6 +7,8 @@ class DocFox::KycApplication::ListService < DocFox::BaseService
 
   # List KYC applications.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications/get
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::ListService.call.first

data/lib/doc_fox/kyc_application/transfer_service.rb

@@ -16,6 +16,8 @@ class DocFox::KycApplication::TransferService < DocFox::BaseService
 
   # Transfer a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1transfer/patch
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::TransferService.call(id: '', transfer_to_user_id: '')

data/lib/doc_fox/kyc_application/unapprove_service.rb

@@ -16,6 +16,8 @@ class DocFox::KycApplication::UnapproveService < DocFox::BaseService
 
   # Unapprove a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1unapprove/patch
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::UnapproveService.call(id: '', reason: '')

data/lib/doc_fox/kyc_application/unarchive_service.rb

@@ -12,6 +12,8 @@ class DocFox::KycApplication::UnarchiveService < DocFox::BaseService
 
   # Unarchive a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Applications/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1unarchive/post
+  #
   # ==== Examples
   #
   #   service = DocFox::KycApplication::UnarchiveService.call(id: '', reason: '')

data/lib/doc_fox/kyc_entity_template/get_service.rb

@@ -15,6 +15,8 @@ class DocFox::KycEntityTemplate::GetService < DocFox::BaseService
 
   # Get a KYC application.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Entity-Templates/paths/~1api~1v2~1kyc_entity_templates~1%7Bkyc_entity_template_id%7D/get
+  #
   # ==== Examples
   #
   #   service = DocFox::KycEntityTemplate::GetService.call(id: '')

data/lib/doc_fox/kyc_entity_template/list_service.rb

@@ -5,6 +5,8 @@ class DocFox::KycEntityTemplate::ListService < DocFox::BaseService
 
   # List KYC entity templates.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/KYC-Entity-Templates/paths/~1api~1v2~1kyc_entity_templates/get
+  #
   # ==== Examples
   #
   #   service = DocFox::KycEntityTemplate::ListService.call.first

data/lib/doc_fox/profile/facade.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class DocFox::Profile::Facade
+  attr_reader :id, :attributes, :relationships, :included, :created_at, :updated_at
+
+  def initialize(hash)
+    @id            = hash.dig('data', 'id') || hash['id']
+    @attributes    = hash.dig('data', 'attributes') || hash['attributes']
+    @relationships = hash.dig('data', 'relationships') || hash['relationships']
+    @included      = hash['included']
+
+    @created_at = attributes['created_at']
+    @updated_at = attributes['updated_at']
+  end
+end

data/lib/doc_fox/profile/get_service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+class DocFox::Profile::GetService < DocFox::BaseService
+  attr_reader :id, :params
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:, params: {})
+    @id     = id
+    @params = params
+  end
+
+  # Get a profile.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Profiles/paths/~1api~1v2~1profiles~1%7Bprofile_id%7D/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::Profile::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::Profile::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  #   service.relationships.dig('names', 'data', 'id')
+  #   service.relationships.dig('numbers', 'links', 'related')
+  #
+  # Include related resources.
+  #
+  #   service = DocFox::Profile::GetService.call(id: '', params: { include: 'names,numbers,additional_details' })
+  #
+  # GET /api/v2/profiles/:id
+  def call
+    connection.get("profiles/#{id}", **params)
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::Profile::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/profile/list_service.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+class DocFox::Profile::ListService < DocFox::BaseService
+  include DocFox::Enumerable
+
+  attr_reader :kyc_application_id
+
+  validates :kyc_application_id, presence: true
+
+  # List profiles.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Profiles/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1profiles/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::Profile::ListService.call(kyc_application_id: '').first
+  #   service.id
+  #   service.created_at
+  #
+  # If you don't provide the `per_page` argument, multiple API requests will be made untill all records have been
+  # returned. You could be rate limited, so use wisely.
+  #
+  #   DocFox::Profile::ListService.call(kyc_application_id: '', page: 1, per_page: 10).map { _1 }
+  #
+  # GET /api/v2/kyc_applications/:kyc_application_id/profiles
+  def initialize(kyc_application_id:, page: 1, per_page: Float::INFINITY)
+    @kyc_application_id = kyc_application_id
+
+    super(
+      path:         "kyc_applications/#{kyc_application_id}/profiles",
+      facade_klass: DocFox::Profile::Facade,
+      page:         page,
+      per_page:     per_page
+    )
+  end
+end

data/lib/doc_fox/status_summary/facade.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class DocFox::StatusSummary::Facade
+  attr_reader :id, :attributes, :relationships, :overall_kyc_application_status, :module_statuses
+
+  def initialize(hash)
+    @id            = hash.dig('data', 'id')
+    @attributes    = hash.dig('data', 'attributes')
+    @relationships = hash.dig('data', 'relationships')
+
+    @overall_kyc_application_status = attributes['overall_kyc_application_status']
+    @module_statuses                = attributes['module_statuses']
+  end
+end

data/lib/doc_fox/status_summary/get_service.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+class DocFox::StatusSummary::GetService < DocFox::BaseService
+  attr_reader :id
+
+  validates :id, presence: true
+
+  after_call :set_facade
+
+  delegate_missing_to :@facade
+
+  def initialize(id:)
+    @id = id
+  end
+
+  # Get a status summary of a KYC application.
+  #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Status-Summaries/paths/~1api~1v2~1kyc_applications~1%7Bkyc_application_id%7D~1status_summaries/get
+  #
+  # ==== Examples
+  #
+  #   service = DocFox::StatusSummary::GetService.call(id: '')
+  #
+  #   service.success? # => true
+  #   service.errors # => #<ActiveModel::Errors []>
+  #
+  #   service.response # => #<Faraday::Response ...>
+  #   service.response.status # => 200
+  #   service.response.body # => {}
+  #
+  #   service.facade # => #<DocFox::StatusSummary::Facade ...>
+  #   service.facade.id
+  #   service.id
+  #
+  #   service.relationships.dig('kyc_application', 'links', 'related')
+  #
+  # GET /api/v2/kyc_applications/:id/status_summaries
+  def call
+    connection.get("kyc_applications/#{id}/status_summaries")
+  end
+
+  private
+
+  def set_facade
+    @facade = DocFox::StatusSummary::Facade.new(response.body)
+  end
+end

data/lib/doc_fox/user/get_service.rb

@@ -15,6 +15,8 @@ class DocFox::User::GetService < DocFox::BaseService
 
   # Get a user.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Users/paths/~1api~1v2~1users~1%7Buser_id%7D/get
+  #
   # ==== Examples
   #
   #   service = DocFox::User::GetService.call(id: '')

data/lib/doc_fox/user/list_service.rb

@@ -5,6 +5,8 @@ class DocFox::User::ListService < DocFox::BaseService
 
   # List users.
   #
+  # https://www.docfoxapp.com/api/v2/documentation#tag/Users/paths/~1api~1v2~1users/get
+  #
   # ==== Examples
   #
   #   service = DocFox::User::ListService.call.first

data/lib/doc_fox/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module DocFox
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/doc_fox.rb

@@ -3,6 +3,7 @@
 require 'active_call'
 require 'active_call/api'
 require 'active_support/core_ext/time'
+require 'faraday/follow_redirects'
 
 loader = Zeitwerk::Loader.for_gem
 loader.ignore("#{__dir__}/active_call-doc_fox.rb")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_call-doc_fox
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kobus Joubert
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-04-05 00:00:00.000000000 Z
+date: 2025-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_call-api
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
@@ -59,7 +73,26 @@ files:
 - lib/doc_fox/authentication/get_service.rb
 - lib/doc_fox/base_service.rb
 - lib/doc_fox/concerns/enumerable.rb
+- lib/doc_fox/data_requirement/facade.rb
+- lib/doc_fox/data_requirement/get_service.rb
+- lib/doc_fox/data_requirement/list_service.rb
+- lib/doc_fox/document/download_service.rb
+- lib/doc_fox/document/facade.rb
+- lib/doc_fox/document/get_service.rb
+- lib/doc_fox/document/list_service.rb
+- lib/doc_fox/document/upload_service.rb
+- lib/doc_fox/document_token/create_service.rb
+- lib/doc_fox/document_token/facade.rb
+- lib/doc_fox/document_token/get_service.rb
+- lib/doc_fox/document_token/list_service.rb
 - lib/doc_fox/error.rb
+- lib/doc_fox/evidence_submission/approve_service.rb
+- lib/doc_fox/evidence_submission/facade.rb
+- lib/doc_fox/evidence_submission/get_service.rb
+- lib/doc_fox/evidence_submission/list_service.rb
+- lib/doc_fox/evidence_submission/reject_service.rb
+- lib/doc_fox/evidence_submission/replace_service.rb
+- lib/doc_fox/evidence_submission/update_service.rb
 - lib/doc_fox/kyc_application/approve_service.rb
 - lib/doc_fox/kyc_application/archive_service.rb
 - lib/doc_fox/kyc_application/create_service.rb
@@ -73,6 +106,11 @@ files:
 - lib/doc_fox/kyc_entity_template/facade.rb
 - lib/doc_fox/kyc_entity_template/get_service.rb
 - lib/doc_fox/kyc_entity_template/list_service.rb
+- lib/doc_fox/profile/facade.rb
+- lib/doc_fox/profile/get_service.rb
+- lib/doc_fox/profile/list_service.rb
+- lib/doc_fox/status_summary/facade.rb
+- lib/doc_fox/status_summary/get_service.rb
 - lib/doc_fox/user/facade.rb
 - lib/doc_fox/user/get_service.rb
 - lib/doc_fox/user/list_service.rb