Skip to content

Commit b106ace

Browse files
Justintime50Justintime50
committed
feat: referral customer billing functions
1 parent 5736de4 commit b106ace

12 files changed

+508
-11
lines changed

‎CHANGELOG.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@
44

55
- Drops support for PHP 8.0
66
- Adds `custom_headers` property to webhook model
7+
- Adds the following functions to assist ReferralCustomers add credit cards and bank accounts:
8+
- `betaReferralCustomer.createCreditCardClientSecret`
9+
- `betaReferralCustomer.createBankAccountClientSecret`
10+
- `referralCustomer.addCreditCardFromStripe`
11+
- `referralCustomer.addBankAccountFromStripe`
712
- Corrects wrapping payload for update webhook endpoint
813
- Corrects various type hints throughout project
914
- Fixes error handling

‎examples

Submodule examples updated 47 files

‎lib/EasyPost/Service/BetaReferralCustomerService.php

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,4 +70,30 @@ public function refundByPaymentLog(string $paymentLogId): mixed
7070

7171
return InternalUtil::convertToEasyPostObject($this->client, $response);
7272
}
73+
74+
/**
75+
* Creates a client secret to use with Stripe when adding a credit card.
76+
*
77+
* @return mixed
78+
*/
79+
public function createCreditCardClientSecret(): mixed
80+
{
81+
$response = Requestor::request($this->client, 'post', '/setup_intents', null, true);
82+
83+
return InternalUtil::convertToEasyPostObject($this->client, $response);
84+
}
85+
86+
/**
87+
* Creates a client secret to use with Stripe when adding a bank account.
88+
*
89+
* @param string|null $returnUrl
90+
* @return mixed
91+
*/
92+
public function createBankAccountClientSecret(?string $returnUrl = null): mixed
93+
{
94+
$params = $returnUrl ? ['return_url' => $returnUrl] : null;
95+
$response = Requestor::request($this->client, 'post', '/financial_connections_sessions', $params, true);
96+
97+
return InternalUtil::convertToEasyPostObject($this->client, $response);
98+
}
7399
}

‎lib/EasyPost/Service/ReferralCustomerService.php

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ public function updateEmail(string $userId, string $email): void
7575
}
7676

7777
/**
78-
* Add a credit card to a referral user.
78+
* Add a credit card to EasyPost for a ReferralCustomer without needing a Stripe account.
7979
*
8080
* This function requires the Referral User's API key.
8181
*
@@ -117,6 +117,63 @@ public function addCreditCard(
117117
return InternalUtil::convertToEasyPostObject($this->client, $response);
118118
}
119119

120+
/**
121+
* Add a credit card to EasyPost for a ReferralCustomer with a payment method ID from Stripe.
122+
*
123+
* This function requires the ReferralCustomer User's API key.
124+
*
125+
* @param string $referralApiKey
126+
* @param string $paymentMethodId
127+
* @param string $priority
128+
* @return mixed
129+
*/
130+
public function addCreditCardFromStripe(
131+
string $referralApiKey,
132+
string $paymentMethodId,
133+
string $priority = 'primary'
134+
): mixed {
135+
$params = [
136+
'credit_card' => [
137+
'payment_method_id' => $paymentMethodId,
138+
'priority' => $priority,
139+
]
140+
];
141+
142+
$client = new EasyPostClient($referralApiKey);
143+
$response = Requestor::request($client, 'post', '/credit_cards', $params);
144+
145+
return InternalUtil::convertToEasyPostObject($this->client, $response);
146+
}
147+
148+
/**
149+
* Add a bank account to EasyPost for a ReferralCustomer.
150+
*
151+
* This function requires the ReferralCustomer User's API key.
152+
*
153+
* @param string $referralApiKey
154+
* @param string $financialConnectionsId
155+
* @param array<mixed> $mandateData
156+
* @param string $priority
157+
* @return mixed
158+
*/
159+
public function addBankAccountFromStripe(
160+
string $referralApiKey,
161+
string $financialConnectionsId,
162+
array $mandateData,
163+
string $priority = 'primary'
164+
): mixed {
165+
$params = [
166+
'financial_connections_id' => $financialConnectionsId,
167+
'mandate_data' => $mandateData,
168+
'priority' => $priority,
169+
];
170+
171+
$client = new EasyPostClient($referralApiKey);
172+
$response = Requestor::request($client, 'post', '/bank_accounts', $params);
173+
174+
return InternalUtil::convertToEasyPostObject($this->client, $response);
175+
}
176+
120177
/**
121178
* Retrieves the public EasyPost Stripe API key.
122179
*

‎test/EasyPost/BetaReferralCustomerTest.php

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public function testAddPaymentMethod(): void
4141
self::$client->betaReferralCustomer->addPaymentMethod(
4242
'cus_123',
4343
'ba_123',
44-
'primary'
44+
Fixture::billing()['priority'],
4545
);
4646
} catch (ApiException $error) {
4747
$this->assertEquals('Invalid connect integration.', $error->getMessage());
@@ -82,4 +82,28 @@ public function testRefundByPaymentLog(): void
8282
$this->assertEquals('We could not find a transaction with that id.', $error->getMessage());
8383
}
8484
}
85+
86+
/**
87+
* Test creating a client secret for credit cards.
88+
*/
89+
public function testCreateCreditCardClientSecret(): void
90+
{
91+
TestUtil::setupCassette('beta/referral_customers/testCreateCreditCardClientSecret.yml');
92+
93+
$response = self::$client->betaReferralCustomer->createCreditCardClientSecret();
94+
95+
$this->assertStringMatchesFormat('seti_%s', $response->client_secret);
96+
}
97+
98+
/**
99+
* Test creating a client secret for bank accounts.
100+
*/
101+
public function testCreateBankAccountClientSecret(): void
102+
{
103+
TestUtil::setupCassette('beta/referral_customers/testCreateBankAccountClientSecret.yml');
104+
105+
$response = self::$client->betaReferralCustomer->createBankAccountClientSecret();
106+
107+
$this->assertStringMatchesFormat('fcsess_client_secret_%s', $response->client_secret);
108+
}
85109
}

‎test/EasyPost/BillingTest.php

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace EasyPost;
44

55
use EasyPost\Constant\Constants;
6+
use EasyPost\Test\Fixture;
67
use EasyPost\Test\Mocking\MockingUtility;
78
use EasyPost\Test\Mocking\MockRequest;
89
use EasyPost\Test\Mocking\MockRequestMatchRule;
@@ -80,7 +81,7 @@ public static function setUpBeforeClass(): void
8081
* @param MockingUtility|null $mockUtility
8182
* @return EasyPostClient
8283
*/
83-
public static function getClient(MockingUtility $mockUtility = null): EasyPostClient
84+
public static function getClient(?MockingUtility $mockUtility = null): EasyPostClient
8485
{
8586
return new EasyPostClient(
8687
getenv('EASYPOST_TEST_API_KEY'),
@@ -96,7 +97,7 @@ public static function getClient(MockingUtility $mockUtility = null): EasyPostCl
9697
public function testFundWallet(): void
9798
{
9899
try {
99-
self::$client->billing->fundWallet('2000', 'primary');
100+
self::$client->billing->fundWallet('2000', Fixture::billing()['priority'],);
100101

101102
$this->expectNotToPerformAssertions();
102103
} catch (\Exception $exception) {
@@ -164,7 +165,7 @@ public function testRetrievePaymentMethodSummaryNoId(): void
164165
public function testDeletePaymentMethod(): void
165166
{
166167
try {
167-
self::$client->billing->deletePaymentMethod('primary');
168+
self::$client->billing->deletePaymentMethod(Fixture::billing()['priority'],);
168169

169170
$this->expectNotToPerformAssertions();
170171
} catch (\Exception $exception) {
@@ -183,7 +184,7 @@ public function testGetPaymentMethodPrioritySwitchCase(): void
183184
{
184185
// testing "primary"
185186
try {
186-
self::$client->billing->deletePaymentMethod('primary');
187+
self::$client->billing->deletePaymentMethod(Fixture::billing()['priority'],);
187188

188189
$this->expectNotToPerformAssertions();
189190
} catch (\Exception $exception) {
@@ -233,7 +234,7 @@ public function testGetPaymentMethodByPriorityNoPaymentMethod(): void
233234
// Deleting a payment method gets the payment method internally, which should execute the
234235
// code that will trigger an exception.
235236
try {
236-
$client->billing->deletePaymentMethod('primary');
237+
$client->billing->deletePaymentMethod(Fixture::billing()['priority'],);
237238

238239
$this->fail('Exception not thrown when we expected one');
239240
} catch (\Exception $exception) {
@@ -265,7 +266,7 @@ public function testGetPaymentMethodByPriorityPaymentMethodNoId(): void
265266
// Deleting a payment method gets the payment method internally, which should execute the
266267
// code that will trigger an exception.
267268
try {
268-
$client->billing->deletePaymentMethod('primary');
269+
$client->billing->deletePaymentMethod(Fixture::billing()['priority'],);
269270

270271
$this->fail('Exception not thrown when we expected one');
271272
} catch (\Exception $exception) {
@@ -306,7 +307,7 @@ public function testGetPaymentMethodInfoByObjectType(): void
306307
// only a delete request to /v2/credit_cards/pm_123 is mocked
307308
// if the delete function works, it's because it found the correct payment method type
308309
try {
309-
$client->billing->deletePaymentMethod('primary');
310+
$client->billing->deletePaymentMethod(Fixture::billing()['priority'],);
310311

311312
$this->expectNotToPerformAssertions();
312313
} catch (\Exception $exception) {

‎test/EasyPost/Fixture.php

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -273,4 +273,12 @@ public static function basicClaimData(): array
273273
{
274274
return self::readFixtureData()['claims']['basic'];
275275
}
276+
277+
/**
278+
* @return array<mixed>
279+
*/
280+
public static function billing(): array
281+
{
282+
return self::readFixtureData()['billing'];
283+
}
276284
}

‎test/EasyPost/ReferralCustomerTest.php

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace EasyPost\Test;
44

55
use EasyPost\EasyPostClient;
6+
use EasyPost\Exception\Api\ApiException;
67
use EasyPost\Exception\General\EndOfPaginationException;
78
use EasyPost\User;
89
use Exception;
@@ -120,7 +121,7 @@ public function testUpdateEmail(): void
120121
* This test requires a partner user's production API key via PARTNER_USER_PROD_API_KEY
121122
* as well as one of that user's referral's production API keys via REFERRAL_USER_PROD_API_KEY.
122123
*/
123-
public function testReferralAddCreditCard(): void
124+
public function testAddCreditCard(): void
124125
{
125126
TestUtil::setupCassette('referral_customers/addCreditCard.yml');
126127

@@ -135,4 +136,53 @@ public function testReferralAddCreditCard(): void
135136
$this->assertStringMatchesFormat('pm_%s', $creditCard->id);
136137
$this->assertEquals('6170', $creditCard->last4);
137138
}
139+
140+
/**
141+
* Test that we can add a credit card to a referral user.
142+
*
143+
* This test requires a referral customer's production API key via REFERRAL_CUSTOMER_PROD_API_KEY.
144+
* We expect this test to fail because we don't have valid billing details to use. Assert the correct error.
145+
*/
146+
public function testAddCreditCardFromStripe(): void
147+
{
148+
TestUtil::setupCassette('referral_customers/addCreditCardFromStripe.yml');
149+
150+
try {
151+
self::$client->referralCustomer->addCreditCardFromStripe(
152+
self::$referralUserProdApiKey,
153+
Fixture::billing()['payment_method_id'],
154+
Fixture::billing()['priority'],
155+
);
156+
} catch (ApiException $error) {
157+
$this->assertEquals(
158+
'Stripe::PaymentMethod does not exist for the specified reference_id',
159+
$error->getMessage()
160+
);
161+
}
162+
}
163+
164+
/**
165+
* Test that we can add a bank account to a referral user.
166+
*
167+
* This test requires a referral customer's production API key via REFERRAL_CUSTOMER_PROD_API_KEY.
168+
* We expect this test to fail because we don't have valid billing details to use. Assert the correct error.
169+
*/
170+
public function testAddBankAccountFromStripe(): void
171+
{
172+
TestUtil::setupCassette('referral_customers/addBankAccountFromStripe.yml');
173+
174+
try {
175+
self::$client->referralCustomer->addBankAccountFromStripe(
176+
self::$referralUserProdApiKey,
177+
Fixture::billing()['financial_connections_id'],
178+
Fixture::billing()['mandate_data'],
179+
Fixture::billing()['priority'],
180+
);
181+
} catch (ApiException $error) {
182+
$this->assertEquals(
183+
'account_holder_name must be present when creating a Financial Connections payment method',
184+
$error->getMessage()
185+
);
186+
}
187+
}
138188
}

‎test/cassettes/beta/referral_customers/testCreateBankAccountClientSecret.yml

Lines changed: 82 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)