Update readme to point to tinker. (bunq/sdk_php#140) #142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
@sandervdo all yours buddy. |
sandervdo
suggested changes
Apr 9, 2018
README.md
Outdated
|
|
||
| After saving the context, you can restore it at any time: | ||
|
|
||
| ```php | ||
| $fileName = '/path/to/bunq.conf/file/'; | ||
| $apiContext = ApiContext::restore($fileName); | ||
| BunqContext:loadApiContext($apiContext); |
README.md
Outdated
| always also needs a reference to a `User`. These dependencies are required as arguments when performing API calls. | ||
| Before you can start making calls, you must ensure that you have create an ApiContext and loaded in into BunqContext as shown in the examples above. | ||
|
|
||
| The SDK will take care of your user Id, as this id wil never change per ApiContext. The SDK also uses your first active monetary account as primary monetary account. This is alsmot always the same as your billing account. This means, if you do not explicitly pass a monetary account id, the SDK will use the billing account id. |
There was a problem hiding this comment.
alsmot.
This means, if you do not explicitly pass a monetary account id, the SDK will use the billing account id.
➡️
This means that when you do not explicitly pass a Monetary Account ID, the SDK will use the Monetary Account ID of your billing account.
README.md
Outdated
| new Pointer(self::POINTER_TYPE_EMAIL, $recipient), | ||
| $description, | ||
| $monetaryAccount->getId() | ||
| ) |
There was a problem hiding this comment.
Hold on ill turn it on :D
README.md
Outdated
| Reading objects through the API requires an `ApiContext`, identifiers of all dependencies (such as User ID required for | ||
| accessing a Monetary Account), and the identifier of the object to read (ID or UUID) Optionally, custom headers can be | ||
| passed to requests. | ||
| To use the read method you must pass the identifier of the object to read (ID or UUID) expect for the endpoints User, UserPerson, UserCompany and monetary account. As the SDK will use default ids if not passed. For all other endpoints you must pass the identifier. |
There was a problem hiding this comment.
expect ➡️ except
monetary account ➡️ Monetary Account
As the SDK will use default ids if not passed ➡️ The SDK will use the default IDs when none are passed.
README.md
Outdated
| #### Updating objects | ||
| Updating objects through the API goes the same way as creating objects, except that also the object to update identifier | ||
| (ID or UUID) is needed. | ||
| You can also retrieve this information from BunqContext, see [`tinker/setupCurrentUser`](https://github.com/bunq/tinker_php/blob/05a38a2660e6f6db1f7efc9b915f0131c172c230/src/BunqLib.php#L117-L120) |
There was a problem hiding this comment.
BunqContext ➡️ `BunqContext`
README.md
Outdated
|
|
||
| ##### Example | ||
| See [`example/customer_statement_export_example.php`](./example/customer_statement_export_example.php) | ||
| CustomerStatementExport::delete($customerStatementExportId) |
|
@sandervdo pushed. |
sandervdo
suggested changes
Apr 10, 2018
README.md
Outdated
| new Pointer(self::POINTER_TYPE_EMAIL, $recipient), | ||
| $description, | ||
| $monetaryAccount->getId() | ||
| ) |
README.md
Outdated
| ``` | ||
|
|
||
| ##### Example | ||
| See [`tinker/BunqLib`](https://github.com/bunq/tinker_php/blob/05a38a2660e6f6db1f7efc9b915f0131c172c230/src/BunqLib.php#L240-L245) | ||
|
|
||
| #### Reading objects | ||
| To use the read method you must pass the identifier of the object to read (ID or UUID) expect for the endpoints User, UserPerson, UserCompany and monetary account. As the SDK will use default ids if not passed. For all other endpoints you must pass the identifier. | ||
| To use the read method you must pass the identifier of the object to read (ID or UUID) except for the endpoints `User`, `UserPerson`, `UserCompany` and `Monetary Account`. The SDK will use the default IDs when none are passed. For all other endpoints you must pass the identifier. |
There was a problem hiding this comment.
We refer to UserPerson and UserCompany then I would also refer to MonetaryAccount
|
@OGKevin -ping-. 💡 |
|
@sandervdo pushed |
sandervdo
approved these changes
Apr 10, 2018
|
LGTM. 👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
References #140