Update SEPA Requests to Encodable
#1173
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,35 @@ | ||
| import Foundation | ||
|
|
||
| /// The POST body for `v1/payment_methods/sepa_debit_accounts` | ||
| struct SEPADebitAccountsRequest: Encodable { | ||
|
|
||
| private let createMandateResult: SEPADebitAccountRequest | ||
|
|
||
| enum CodingKeys: String, CodingKey { | ||
| case createMandateResult = "sepa_debit_account" | ||
| } | ||
|
|
||
| init(createMandateResult: CreateMandateResult) { | ||
|
There was a problem hiding this comment. Nit - I would move the init to the bottom of this class. Maybe these new Encodable structs is a good candidate for us to add to our style guide how we should organize these, MARKs, etc There was a problem hiding this comment. I had followed the pattern we established in BTApplePaymentTokensRequest where the nested struct is under the There was a problem hiding this comment. Yeh, looking back I think having all the struct definitions be near the property that uses it & pushing the init down is more readable vs having them intertwined. What do you think? In terms of nested structs, I think they sometimes help readability to know when something is defined within the context of something else. For example with the ApplePaymentToken one, that name is pretty generic, but namespacing it the Open to folks thoughts though! There was a problem hiding this comment.
Yeah I am down if we feel like it makes things more readable! I pushed a commit here with the change: d479ab9 Also agree on style guiding whatever we decide (and finding a home for the style guide).
That makes sense with naming collisions, I forgot about that aspect. Especially with something like There was a problem hiding this comment. I added a backlog ticket for updating our style guide - DTBTSDK-3373 |
||
| self.createMandateResult = SEPADebitAccountRequest( | ||
| last4: createMandateResult.ibanLastFour, | ||
| merchantOrPartnerCustomerID: createMandateResult.customerID, | ||
| bankReferenceToken: createMandateResult.bankReferenceToken, | ||
| mandateType: createMandateResult.mandateType | ||
| ) | ||
| } | ||
|
|
||
| struct SEPADebitAccountRequest: Encodable { | ||
|
|
||
| let last4: String? | ||
| let merchantOrPartnerCustomerID: String? | ||
| let bankReferenceToken: String? | ||
| let mandateType: String? | ||
|
Comment on lines
+14
to
+17
There was a problem hiding this comment. nit(entirely optional): maybe we can add short in-line docs to describe each property within these structs |
||
|
|
||
| enum CodingKeys: String, CodingKey { | ||
| case last4 = "last_4" | ||
| case merchantOrPartnerCustomerID = "merchant_or_partner_customer_id" | ||
| case bankReferenceToken = "bank_reference_token" | ||
| case mandateType = "mandate_type" | ||
| } | ||
| } | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| import Foundation | ||
|
|
||
| #if canImport(BraintreeCore) | ||
| import BraintreeCore | ||
| #endif | ||
|
|
||
| /// The POST body for `v1/sepa_debit` | ||
| struct SEPADebitRequest: Encodable { | ||
|
|
||
| let merchantAccountID: String? | ||
| let cancelURL: String? | ||
| let returnURL: String? | ||
| let locale: String? | ||
|
|
||
| private let sepaAccountRequest: SEPAAccountRequest | ||
|
|
||
| enum CodingKeys: String, CodingKey { | ||
| case sepaAccountRequest = "sepa_debit" | ||
| case merchantAccountID = "merchant_account_id" | ||
| case cancelURL = "cancel_url" | ||
| case returnURL = "return_url" | ||
| case locale = "locale" | ||
| } | ||
|
|
||
| init(sepaDirectDebitRequest: BTSEPADirectDebitRequest) { | ||
| self.sepaAccountRequest = SEPAAccountRequest(sepaDirectDebitRequest: sepaDirectDebitRequest) | ||
| self.merchantAccountID = sepaDirectDebitRequest.merchantAccountID | ||
| self.cancelURL = BTCoreConstants.callbackURLScheme + "://sepa/cancel" | ||
| self.returnURL = BTCoreConstants.callbackURLScheme + "://sepa/success" | ||
| self.locale = sepaDirectDebitRequest.locale | ||
| } | ||
|
|
||
| struct SEPAAccountRequest: Encodable { | ||
|
|
||
| let merchantOrPartnerCustomerID: String? | ||
| let mandateType: String? | ||
| let accountHolderName: String? | ||
| let iban: String? | ||
| let billingAddress: BillingAddress? | ||
|
|
||
| enum CodingKeys: String, CodingKey { | ||
| case merchantOrPartnerCustomerID = "merchant_or_partner_customer_id" | ||
| case mandateType = "mandate_type" | ||
| case accountHolderName = "account_holder_name" | ||
| case iban = "iban" | ||
| case billingAddress = "billing_address" | ||
| } | ||
|
|
||
| init(sepaDirectDebitRequest: BTSEPADirectDebitRequest) { | ||
| self.merchantOrPartnerCustomerID = sepaDirectDebitRequest.customerID | ||
| self.mandateType = sepaDirectDebitRequest.mandateType?.description | ||
| self.accountHolderName = sepaDirectDebitRequest.accountHolderName | ||
| self.iban = sepaDirectDebitRequest.iban | ||
| self.billingAddress = BillingAddress( | ||
| streetAddress: sepaDirectDebitRequest.billingAddress?.streetAddress, | ||
| extendedAddress: sepaDirectDebitRequest.billingAddress?.extendedAddress, | ||
| locality: sepaDirectDebitRequest.billingAddress?.locality, | ||
| region: sepaDirectDebitRequest.billingAddress?.region, | ||
| postalCode: sepaDirectDebitRequest.billingAddress?.postalCode, | ||
| countryCodeAlpha2: sepaDirectDebitRequest.billingAddress?.countryCodeAlpha2 | ||
| ) | ||
| } | ||
|
|
||
| struct BillingAddress: Encodable { | ||
|
|
||
| let streetAddress: String? | ||
| let extendedAddress: String? | ||
| let locality: String? | ||
| let region: String? | ||
| let postalCode: String? | ||
| let countryCodeAlpha2: String? | ||
|
|
||
| enum CodingKeys: String, CodingKey { | ||
| case streetAddress = "address_line_1" | ||
| case extendedAddress = "address_line_2" | ||
| case locality = "admin_area_1" | ||
| case region = "admin_area_2" | ||
| case postalCode = "postal_code" | ||
| case countryCodeAlpha2 = "country_code" | ||
| } | ||
| } | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
❓ - do we want to create a
/Modelsdirectory within eachSources/<PaymentMethod>directory? Specifically to house these new classes specific to encoding (and maybe eventually to house ones specific to decoding if we go that route).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, I think that would be helpful. I was thinking that as I was adding this. Should we do that as a follow up PR for all of the models we've created so far? I think it changes the source paths for the package managers (at least Cocoapods). Also down to do that for SEPA in this PR and just a follow up for the other 2. Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the idea of having those be 1 PR! But your call
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool - agree we can 🏈 on it in this PR to establish a pattern in a single PR moving forward