Merge pull request #19 from veryfi/LP-1230-add-contract-apis

LP-1230: Add contract apis

Author: alejouribesanchez

.github/workflows/tests.yml

@@ -33,6 +33,7 @@ let package = Package(
                 .copy("Resources/w2.png"),
                 .copy("Resources/split.pdf"),
                 .copy("Resources/check.pdf"),
+                .copy("Resources/contract.pdf"),
                 .copy("Resources/deleteDocument.json"),
                 .copy("Resources/getDocument.json"),
                 .copy("Resources/getDocuments.json"),
@@ -63,7 +64,12 @@ let package = Package(
                 .copy("Resources/processCheck.json"),
                 .copy("Resources/getCheck.json"),
                 .copy("Resources/getChecks.json"),
-                .copy("Resources/deleteCheck.json")
+                .copy("Resources/deleteCheck.json"),
+                .copy("Resources/processContract.json"),
+                .copy("Resources/getContract.json"),
+                .copy("Resources/getContracts.json"),
+                .copy("Resources/updateContract.json"),
+                .copy("Resources/deleteContract.json")
             ]
         )
     ]

Package.swift

@@ -0,0 +1,18 @@
+//
+//  DeleteContract.swift
+//  VeryfiSDK
+//
+//  Created by Veryfi on 25/10/24.
+//
+import Foundation
+
+extension Client {
+    /// Delete contract from Veryfi inbox.
+    /// https://docs.veryfi.com/api/contracts/delete-a-contract/
+    /// - Parameters:
+    ///   - contractId: ID of contract to delete.
+    ///   - completion: completion description
+    public func deleteContract(contractId: Int, withCompletion completion: @escaping (Result<Data, APIError>) -> Void) {
+        self.request(method: .DELETE, route: .contracts, queryItem: String(contractId), completion: completion)
+    }
+} 

Sources/VeryfiSDK/Client/DeleteContract.swift

@@ -0,0 +1,20 @@
+//
+//  GetContract.swift
+//  VeryfiSDK
+//
+//  Created by Veryfi on 25/10/24.
+//
+import Foundation
+
+extension Client {
+    /// Get a specific contract from Veryfi inbox.
+    /// https://docs.veryfi.com/api/contracts/get-a-contract/
+    /// - Parameters:
+    ///   - contractId: ID of contract to retrieve.
+    ///   - completion: Block executed after request.
+    ///   - detail: Response from server.
+    ///   - error: Error from server.
+    public func getContract(contractId: Int, withCompletion completion: @escaping (Result<Data, APIError>) -> Void) {
+        self.request(method: .GET, route: .contracts, queryItem: String(contractId), completion: completion)
+    }
+} 

Sources/VeryfiSDK/Client/GetContract.swift

@@ -0,0 +1,20 @@
+//
+//  GetContracts.swift
+//  VeryfiSDK
+//
+//  Created by Veryfi on 25/10/24.
+//
+import Foundation
+
+extension Client {
+    /// Get all contracts from Veryfi inbox.
+    /// https://docs.veryfi.com/api/contracts/get-contracts/
+    /// - Parameters:
+    ///   - queryItems: Query items to apply to the get request (e.g., page, page_size).
+    ///   - completion: Block executed after request.
+    ///   - detail: Response from server.
+    ///   - error: Error from server.
+    public func getContracts(queryItems: [URLQueryItem]? = nil, withCompletion completion: @escaping (Result<Data, APIError>) -> Void) {
+        self.request(method: .GET, route: .contracts, queryItems: queryItems, completion: completion)
+    }
+} 

Sources/VeryfiSDK/Client/GetContracts.swift

@@ -0,0 +1,40 @@
+//
+//  ProcessContract.swift
+//  VeryfiSDK
+//
+//  Created by Veryfi on 25/10/24.
+//
+import Foundation
+
+extension Client {
+    /// Upload a contract for the Veryfi API to process.
+    /// https://docs.veryfi.com/api/contracts/process-a-contract/
+    /// - Parameters:
+    ///     - fileName: Name of the file to upload to the Veryfi API.
+    ///     - fileData: UTF8 encoded file data
+    ///     - deleteAfterProcessing: Do not store file in Veryfi's inbox.
+    ///     - maxPagesToProcess: Limit processing to number of pages (1-50, default 50).
+    ///     - params: Additional parameters.
+    ///     - completion: Function called after request completes.
+    ///     -  detail: Response from server.
+    ///     -  error: Error from server.
+    public func processContract(fileName: String,
+                               fileData: Data,
+                               deleteAfterProcessing: Bool = false,
+                               maxPagesToProcess: Int = 50,
+                               params: [String: Any]? = nil,
+                               withCompletion completion: @escaping (Result<Data, APIError>) -> Void) {
+        var requestParams = params ?? [String: Any]()
+        requestParams["auto_delete"] = deleteAfterProcessing
+        requestParams["max_pages_to_process"] = maxPagesToProcess
+        requestParams["file_data"] = fileData.base64EncodedString()
+        requestParams["file_name"] = fileName
+
+        guard let jsonData = try? JSONSerialization.data(withJSONObject: requestParams, options: .prettyPrinted) else {
+            completion(.failure(.parsingError))
+            return
+        }
+
+        self.request(method: .POST, route: .contracts, uploadData: jsonData, completion: completion)
+    }
+} 

Sources/VeryfiSDK/Client/ProcessContract.swift

@@ -0,0 +1,52 @@
+//
+//  ProcessContractUrl.swift
+//  VeryfiSDK
+//
+//  Created by Veryfi on 25/10/24.
+//
+import Foundation
+
+extension Client {
+    /// Upload a contract from URL for the Veryfi API to process.
+    /// https://docs.veryfi.com/api/contracts/process-a-contract/
+    /// - Parameters:
+    ///     - fileUrl: URL of the file to upload to the Veryfi API.
+    ///     - fileUrls: Array of URLs to publicly accessible documents.
+    ///     - deleteAfterProcessing: Do not store file in Veryfi's inbox.
+    ///     - maxPagesToProcess: Limit processing to number of pages (1-50, default 50).
+    ///     - externalId: External ID to associate with the document.
+    ///     - params: Additional parameters.
+    ///     - completion: Function called after request completes.
+    ///     -  detail: Response from server.
+    ///     -  error: Error from server.
+    public func processContractURL(fileUrl: String? = nil,
+                                  fileUrls: [String]? = nil,
+                                  deleteAfterProcessing: Bool = false,
+                                  maxPagesToProcess: Int = 50,
+                                  externalId: String? = nil,
+                                  params: [String: Any]? = nil,
+                                  withCompletion completion: @escaping (Result<Data, APIError>) -> Void) {
+        var requestParams = params ?? [String: Any]()
+        requestParams["auto_delete"] = deleteAfterProcessing
+        requestParams["max_pages_to_process"] = maxPagesToProcess
+        
+        if let fileUrl = fileUrl {
+            requestParams["file_url"] = fileUrl
+        }
+        
+        if let fileUrls = fileUrls {
+            requestParams["file_urls"] = fileUrls
+        }
+        
+        if let externalId = externalId {
+            requestParams["external_id"] = externalId
+        }
+
+        guard let jsonData = try? JSONSerialization.data(withJSONObject: requestParams, options: .prettyPrinted) else {
+            completion(.failure(.parsingError))
+            return
+        }
+
+        self.request(method: .POST, route: .contracts, uploadData: jsonData, completion: completion)
+    }
+} 

Sources/VeryfiSDK/Client/ProcessContractUrl.swift

@@ -0,0 +1,22 @@
+//
+//  UpdateContract.swift
+//  VeryfiSDK
+//
+//  Created by Veryfi on 25/10/24.
+//
+import Foundation
+
+extension Client {
+    /// Update information of contract in Veryfi inbox.
+    /// https://docs.veryfi.com/api/contracts/update-a-contract/
+    /// - Parameters:
+    ///   - contractId: ID of contract to modify.
+    ///   - params: Names and values to modify.
+    ///   - completion: A block to execute
+    ///   - detail: Response from server.
+    ///   - error: Error from server.
+    public func updateContract(contractId: Int, params: [String: Any], withCompletion completion: @escaping (Result<Data, APIError>) -> Void) {
+        let jsonData = try? JSONSerialization.data(withJSONObject: params)
+        self.request(method: .PUT, route: .contracts, body: jsonData, queryItem: String(contractId), completion: completion)
+    }
+} 

Sources/VeryfiSDK/Client/UpdateContract.swift

@@ -26,6 +26,7 @@ enum Endpoint: String {
     case classify = "/partner/classify/"
     case split = "/partner/documents-set/"
     case checks = "/partner/checks/"
+    case contracts = "/partner/contracts/"
 }
 
 public class NetworkManager {

Sources/VeryfiSDK/NetworkManager.swift

@@ -46,7 +46,13 @@ extension VeryfiSDKTests {
             ("testProcessCheckURL", testProcessCheckURL),
             ("testGetCheck", testGetCheck),
             ("testGetChecks", testGetChecks),
-            ("testDeleteCheck", testDeleteCheck)
+            ("testDeleteCheck", testDeleteCheck),
+            ("testProcessContract", testProcessContract),
+            ("testProcessContractURL", testProcessContractURL),
+            ("testGetContracts", testGetContracts),
+            ("testGetContract", testGetContract),
+            ("testDeleteContract", testDeleteContract),
+            ("testUpdateContract", testUpdateContract)
         ]
     }
 }