Merge pull request #92 from vapor-community/persons

Implemented Persons API for connect accounts.

README.md

@@ -85,7 +85,7 @@ And you can always check the documentation to see the required paramaters for sp
 * [ ] Application Fees
 * [ ] Country Specs
 * [ ] External Accounts
-* [ ] Persons
+* [x] Persons
 * [ ] Top-ups
 * [x] Transfers
 * [x] Transfer Reversals

Sources/Stripe/API/Helpers/Endpoints.swift

@@ -123,6 +123,10 @@ internal enum StripeAPIEndpoint {
     case file
     case files(String)
 
+    // MARK: - PERSONS
+    case person(String)
+    case persons(String, String)
+
     var endpoint: String {
         switch self {
         case .balance: return APIBase + APIVersion + "balance"
@@ -210,6 +214,9 @@ internal enum StripeAPIEndpoint {
 
         case .file: return FilesAPIBase + APIVersion + "files"
         case .files(let id): return FilesAPIBase + APIVersion + "files/\(id)"
+
+        case .person(let account): return APIBase + APIVersion + "accounts/\(account)/persons"
+        case .persons(let account, let person): return APIBase + APIVersion + "accounts/\(account)/persons\(person)"
         }
     }
 }

Sources/Stripe/API/Routes/PersonRoutes.swift

@@ -0,0 +1,350 @@
+//
+//  PersonRoutes.swift
+//  Stripe
+//
+//  Created by Andrew Edwards on 2/28/19.
+//
+
+import Vapor
+
+public protocol PersonRoutes {
+    /// Creates a new person.
+    ///
+    /// - Parameters:
+    ///   - account: The unique identifier of the account the person is associated with.
+    ///   - address: The person’s address.
+    ///   - dob: The person’s date of birth.
+    ///   - email: The person’s email address.
+    ///   - firstName: The person’s first name.
+    ///   - gender: The person’s gender (International regulations require either “male” or “female”).
+    ///   - idNumber: The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
+    ///   - lastName: The person’s last name.
+    ///   - maidenName: The person’s maiden name.
+    ///   - metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
+    ///   - phone: The person’s phone number.
+    ///   - relationship: The relationship that this person has with the account’s legal entity.
+    ///   - ssnLast4: The last 4 digits of the person’s social security number.
+    ///   - verification: The person’s verification status.
+    /// - Returns: Returns a person object.
+    /// - Throws: A `StripeError`
+    func create(account: String,
+                address: [String: Any]?,
+                dob: [String: Any]?,
+                email: String?,
+                firstName: String?,
+                gender: StripePersonGender?,
+                idNumber: String?,
+                lastName: String?,
+                maidenName: String?,
+                metadata: [String: String]?,
+                phone: String?,
+                relationship: [String: Any]?,
+                ssnLast4: String?,
+                verification: [String: Any]?) throws -> EventLoopFuture<StripePerson>
+
+    /// Retrieves an existing person.
+    ///
+    /// - Parameters:
+    ///   - account: The unique identifier of the account the person is associated with.
+    ///   - person: The ID of a person to retrieve.
+    /// - Returns: Returns a person object.
+    /// - Throws: A `StripeError`
+    func retrieve(account: String, person: String) throws -> EventLoopFuture<StripePerson>
+
+    /// Updates an existing person.
+    ///
+    /// - Parameters:
+    ///   - account: The unique identifier of the account the person is associated with.
+    ///   - person: The ID of a person to update.
+    ///   - address: The person’s address.
+    ///   - dob: The person’s date of birth.
+    ///   - email: The person’s email address.
+    ///   - firstName: The person’s first name.
+    ///   - gender: The person’s gender (International regulations require either “male” or “female”).
+    ///   - idNumber: The person’s ID number, as appropriate for their country. For example, a social security number in the U.S., social insurance number in Canada, etc. Instead of the number itself, you can also provide a PII token provided by Stripe.js.
+    ///   - lastName: The person’s last name.
+    ///   - maidenName: The person’s maiden name.
+    ///   - metadata: Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.
+    ///   - phone: The person’s phone number.
+    ///   - relationship: The relationship that this person has with the account’s legal entity.
+    ///   - ssnLast4: The last 4 digits of the person’s social security number.
+    ///   - verification: The person’s verification status.
+    /// - Returns: Returns a person object.
+    /// - Throws: A `StripeError`
+    func update(account: String,
+                person: String,
+                address: [String: Any]?,
+                dob: [String: Any]?,
+                email: String?,
+                firstName: String?,
+                gender: StripePersonGender?,
+                idNumber: String?,
+                lastName: String?,
+                maidenName: String?,
+                metadata: [String: String]?,
+                phone: String?,
+                relationship: [String: Any]?,
+                ssnLast4: String?,
+                verification: [String: Any]?) throws -> EventLoopFuture<StripePerson>
+
+    /// Deletes an existing person’s relationship to the account’s legal entity.
+    ///
+    /// - Parameters:
+    ///   - account: The unique identifier of the account the person is associated with.
+    ///   - person: The ID of a person to update.
+    /// - Returns: Returns the deleted person object.
+    /// - Throws: A `StripeError`
+    func delete(account: String, person: String) throws -> EventLoopFuture<StripeDeletedObject>
+
+    /// Returns a list of people associated with the account’s legal entity. The people are returned sorted by creation date, with the most recent people appearing first.
+    ///
+    /// - Parameters:
+    ///   - account: The unique identifier of the account the person is associated with.
+    ///   - filter: A dictionary that will be used for the query parameters. [See More →](https://stripe.com/docs/api/persons/list?&lang=curl)
+    /// - Returns: A `PersonsList`
+    /// - Throws: A `StripeError`
+    func listAll(account: String, filter: [String: Any]?) throws -> EventLoopFuture<PersonsList>
+}
+
+extension PersonRoutes {
+    public func create(account: String,
+                       address: [String: Any]? = nil,
+                       dob: [String: Any]? = nil,
+                       email: String? = nil,
+                       firstName: String? = nil,
+                       gender: StripePersonGender? = nil,
+                       idNumber: String? = nil,
+                       lastName: String? = nil,
+                       maidenName: String? = nil,
+                       metadata: [String: String]? = nil,
+                       phone: String? = nil,
+                       relationship: [String: Any]? = nil,
+                       ssnLast4: String?,
+                       verification: [String: Any]? = nil) throws -> EventLoopFuture<StripePerson> {
+        return try create(account: account,
+                          address: address,
+                          dob: dob,
+                          email: email,
+                          firstName: firstName,
+                          gender: gender,
+                          idNumber: idNumber,
+                          lastName: lastName,
+                          maidenName: maidenName,
+                          metadata: metadata,
+                          phone: phone,
+                          relationship: relationship,
+                          ssnLast4: ssnLast4,
+                          verification: verification)
+    }
+
+    public func retrieve(account: String, person: String) throws -> EventLoopFuture<StripePerson> {
+        return try retrieve(account: account, person: person)
+    }
+
+    public func update(account: String,
+                       person: String,
+                       address: [String: Any]? = nil,
+                       dob: [String: Any]? = nil,
+                       email: String? = nil,
+                       firstName: String? = nil,
+                       gender: StripePersonGender? = nil,
+                       idNumber: String? = nil,
+                       lastName: String? = nil,
+                       maidenName: String? = nil,
+                       metadata: [String: String]? = nil,
+                       phone: String? = nil,
+                       relationship: [String: Any]? = nil,
+                       ssnLast4: String? = nil,
+                       verification: [String: Any]? = nil) throws -> EventLoopFuture<StripePerson> {
+        return try update(account: account,
+                          person: person,
+                          address: address,
+                          dob: dob,
+                          email: email,
+                          firstName: firstName,
+                          gender: gender,
+                          idNumber: idNumber,
+                          lastName: lastName,
+                          maidenName: maidenName,
+                          metadata: metadata,
+                          phone: phone,
+                          relationship: relationship,
+                          ssnLast4: ssnLast4,
+                          verification: verification)
+    }
+
+    func delete(account: String, person: String) throws -> EventLoopFuture<StripeDeletedObject> {
+        return try delete(account: account, person: person)
+    }
+
+    func listAll(account: String, filter: [String: Any]? = nil) throws -> EventLoopFuture<PersonsList> {
+        return try listAll(account: account, filter: filter)
+    }
+}
+
+public struct StripePersonRoutes: PersonRoutes {
+    private let request: StripeRequest
+
+    init(request: StripeRequest) {
+        self.request = request
+    }
+
+    public func create(account: String,
+                       address: [String: Any]?,
+                       dob: [String: Any]?,
+                       email: String?,
+                       firstName: String?,
+                       gender: StripePersonGender?,
+                       idNumber: String?,
+                       lastName: String?,
+                       maidenName: String?,
+                       metadata: [String: String]?,
+                       phone: String?,
+                       relationship: [String: Any]?,
+                       ssnLast4: String?,
+                       verification: [String: Any]?) throws -> EventLoopFuture<StripePerson> {
+        var body: [String: Any] = [:]
+
+        if let address = address {
+            address.forEach { body["address[\($0)]"] = $1 }
+        }
+
+        if let dob = dob {
+            dob.forEach { body["dob[\($0)]"] = $1 }
+        }
+
+        if let email = email {
+            body["email"] = email
+        }
+
+        if let firstName = firstName {
+            body["first_name"] = firstName
+        }
+
+        if let gender = gender {
+            body["gender"] = gender.rawValue
+        }
+
+        if let idNumber = idNumber {
+            body["id_number"] = idNumber
+        }
+
+        if let lastName = lastName {
+            body["last_name"] = lastName
+        }
+
+        if let maidenName = maidenName {
+            body["maiden_name"] = maidenName
+        }
+
+        if let metadata = metadata {
+            metadata.forEach { body["metadata[\($0)]"] = $1 }
+        }
+
+        if let phone = phone {
+            body["phone"] = phone
+        }
+
+        if let relationship = relationship {
+            relationship.forEach { body["relationship[\($0)]"] = $1 }
+        }
+
+        if let ssnLast4 = ssnLast4 {
+            body["ssn_last_4"] = ssnLast4
+        }
+
+        if let verification = verification {
+            verification.forEach { body["verification[\($0)]"] = $1 }
+        }
+
+        return try request.send(method: .POST, path: StripeAPIEndpoint.person(account).endpoint, body: body.queryParameters)
+    }
+
+    public func retrieve(account: String, person: String) throws -> EventLoopFuture<StripePerson> {
+        return try request.send(method: .GET, path: StripeAPIEndpoint.persons(account, person).endpoint)
+    }
+
+    public func update(account: String,
+                       person: String,
+                       address: [String: Any]?,
+                       dob: [String: Any]?,
+                       email: String?,
+                       firstName: String?,
+                       gender: StripePersonGender?,
+                       idNumber: String?,
+                       lastName: String?,
+                       maidenName: String?,
+                       metadata: [String: String]?,
+                       phone: String?,
+                       relationship: [String: Any]?,
+                       ssnLast4: String?,
+                       verification: [String: Any]?) throws -> EventLoopFuture<StripePerson> {
+        var body: [String: Any] = [:]
+
+        if let address = address {
+            address.forEach { body["address[\($0)]"] = $1 }
+        }
+
+        if let dob = dob {
+            dob.forEach { body["dob[\($0)]"] = $1 }
+        }
+
+        if let email = email {
+            body["email"] = email
+        }
+
+        if let firstName = firstName {
+            body["first_name"] = firstName
+        }
+
+        if let gender = gender {
+            body["gender"] = gender.rawValue
+        }
+
+        if let idNumber = idNumber {
+            body["id_number"] = idNumber
+        }
+
+        if let lastName = lastName {
+            body["last_name"] = lastName
+        }
+
+        if let maidenName = maidenName {
+            body["maiden_name"] = maidenName
+        }
+
+        if let metadata = metadata {
+            metadata.forEach { body["metadata[\($0)]"] = $1 }
+        }
+
+        if let phone = phone {
+            body["phone"] = phone
+        }
+
+        if let relationship = relationship {
+            relationship.forEach { body["relationship[\($0)]"] = $1 }
+        }
+
+        if let ssnLast4 = ssnLast4 {
+            body["ssn_last_4"] = ssnLast4
+        }
+
+        if let verification = verification {
+            verification.forEach { body["verification[\($0)]"] = $1 }
+        }
+
+        return try request.send(method: .POST, path: StripeAPIEndpoint.persons(account, person).endpoint, body: body.queryParameters)
+    }
+
+    public func delete(account: String, person: String) throws -> EventLoopFuture<StripeDeletedObject> {
+        return try request.send(method: .DELETE, path: StripeAPIEndpoint.persons(account, person).endpoint)
+    }
+
+    public func listAll(account: String, filter: [String : Any]?) throws -> EventLoopFuture<PersonsList> {
+        var queryParams = ""
+        if let filter = filter {
+            queryParams = filter.queryParameters
+        }
+        return try request.send(method: .GET, path: StripeAPIEndpoint.person(account).endpoint, query: queryParams)
+    }
+}

Sources/Stripe/API/StripeRequest.swift

@@ -25,12 +25,12 @@ public extension StripeRequest {
         decoder.dateDecodingStrategy = .secondsSince1970
 
         guard response.status == .ok else {
-            return try decoder.decode(StripeError.self, from: response, maxSize: 65_536, on: worker).map(to: SM.self){ error in
+            return try decoder.decode(StripeError.self, from: response, maxSize: 1_000_000, on: worker).map(to: SM.self){ error in
                 throw error
             }
         }
 
-        return try decoder.decode(SM.self, from: response, maxSize: 65_536, on: worker)
+        return try decoder.decode(SM.self, from: response, maxSize: 1_000_000, on: worker)
     }
 }