Skip to content

Commit 87e9173

Browse files
Merge pull request #248 from square/brandonjenniges/documentation-updates
Documentation updates
2 parents 62155ba + 62bf54e commit 87e9173

File tree

3 files changed

+7
-39
lines changed

3 files changed

+7
-39
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In addition to this README, the following is available in the [React Native plug
3131

3232
### iOS
3333

34-
* Xcode version: 14.1 or greater.
34+
* Xcode version: 15.0 or greater.
3535
* iOS Base SDK: 13.0 or greater.
3636
* Deployment target: iOS 13.0 or greater.
3737

docs/reference.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# In-App Payments SDK React Native Plugin Technical Reference
22

3-
This technical reference documents methods available in the React Native
4-
plugin for In-App Payments SDK. For detailed documentation on In-App Payments SDK, please see
5-
[https://developer.squareup.com/docs/].
3+
This technical reference outlines the methods available in the React Native plugin for the In-App Payments SDK. For comprehensive documentation on the In-App Payments SDK, visit [this link](https://developer.squareup.com/docs/in-app-payments-sdk/what-it-does).
64

75
---
86

@@ -269,7 +267,7 @@ if (Platform.OS === 'ios') {
269267
---
270268
### startBuyerVerificationFlow
271269

272-
Starts the buyer verification for a given payment source id. The most likely use case will be to pass in a card-on-file (cof). This will display a verification view to the user for some geographies to address Strong Customer Authentication. The method takes two callback parameters which correspond to the possible results of the request.
270+
Starts the buyer verification for a given payment source id. The most likely use case will be to pass in a card-on-file (cof). This will display a verification view to the user for some geographies to address Strong Customer Authentication. The method takes two callback parameters which correspond to the possible results of the request. Please see [this link](https://developer.squareup.com/docs/in-app-payments-sdk/verify-buyer) for more detailed documentation on this flow.
273271

274272
Parameter | Type | Description
275273
:----------------------------------| :---------------------------------------------------------------------------- | :-----------
@@ -279,7 +277,7 @@ onBuyerVerificationSuccess | [BuyerVerificationSuccessCallback](#BuyerVerificati
279277
onBuyerVerificationFailure | [BuyerVerificationErrorCallback](#BuyerVerificationErrorCallback) | Invoked when card entry with buyer verification encounters errors.
280278
onCardEntryCancel | [cardEntryCancelCallback](#cardentrycancelcallback) | Invoked when card entry is canceled.
281279

282-
#### Example usage
280+
#### Example usage for a charge
283281

284282
```javascript
285283
import {
@@ -290,7 +288,7 @@ const paymentSourceId = 'ccof:customer-card-id-requires-verification';
290288
const cardEntryConfig = {
291289
collectPostalCode: true,
292290
squareLocationId: SQUARE_LOCATION_ID,
293-
buyerAction: 'Charge',
291+
buyerAction: 'Charge', // Either Charge or Store, depending on your usage.
294292
amount: 100,
295293
currencyCode: 'USD',
296294
givenName: 'John',

docs/troubleshooting.md

Lines changed: 2 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -46,42 +46,12 @@ To prevent this from happening, please always close the card entry UI before rel
4646
---
4747

4848

49-
## I get Xcode compile errors when building In-App Payments SDK
50-
51-
### The problem
52-
53-
You are building your React Native project with Xcode instead of the React Native
54-
command line interface (CLI) and using Xcode 10. Xcode 10 builds projects
55-
differently than earlier versions.
56-
57-
### Likely cause
58-
59-
You recently downloaded or updated Xcode.
60-
61-
### Solution
62-
63-
There are 2 ways to address the issue:
64-
65-
1. Build with the React Native CLI instead of Xcode.
66-
67-
**OR**
68-
69-
2. Configure Xcode to use the legacy build system:
70-
1. Open `File > Project Settings... > Per-User Project Settings`
71-
2. Choose `Legacy Build System`
72-
3. Run `react-native clean` from the command line.
73-
74-
---
75-
76-
7749
## I get thre Error ":CFBundleIdentifier", Does Not Exist
7850

7951
### The problem
8052

81-
Your IOS configuration files are missing or not correctly configured.
53+
Your iOS configuration files are missing or not correctly configured.
8254

8355
### Solution
8456

85-
There is a stackoverflow question that adresses this problem:
86-
87-
https://stackoverflow.com/questions/37461703/print-entry-cfbundleidentifier-does-not-exist.
57+
There is a [stackoverflow question](https://stackoverflow.com/questions/37461703/print-entry-cfbundleidentifier-does-not-exist) that adresses this problem.

0 commit comments

Comments
 (0)