Skip to content

Commit ee811fb

Browse files
committed
small README fixes
1 parent 779bc1d commit ee811fb

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Here are examples of the minimum config.json for different Xero App Types.
167167

168168
### Custom Configuration
169169

170-
You have the option to implement your own Config class and pass it as an argument to the OAuthRequestToken, OAuthAccessToken and XeroClient constructors.
170+
You have the option to implement your own Config class and pass it as an argument to the OAuthRequestToken, OAuthAccessToken and Api Clients (AccountingApi, AssetsApi, etc).
171171

172172
An example of how you might implement Config can be found in the `/src/main/java/com/xero/example` folder named `CustomJsonConfig.java`.
173173

@@ -178,6 +178,7 @@ An alternative method of configuring the Xero Java SDK can be found in the `exam
178178
This class reads the configuration from the spring `Environment` backed by the `application.properties`. This handy way of configuring the SDK
179179
allows spring profiles to control your production and development environments.
180180

181+
This code should be updated and replace XeroClient with new Clients (AccountingApi, AssetsApi, etc)
181182
```java
182183
@Bean
183184
public XeroClient xeroClient(Environment environment) {
@@ -200,7 +201,7 @@ xero.PrivateKeyPassword=
200201

201202
## Customize Request Signing
202203

203-
You can provide your own signing mechanism by using the `public XeroClient(Config config, SignerFactory signerFactory)` constructor. Simply implement the `SignerFactory` interface with your implementation.
204+
You can provide your own signing mechanism by using the `public AccountingApi(Config config, SignerFactory signerFactory)` constructor. Simply implement the `SignerFactory` interface with your implementation.
204205

205206
You can also provide a `RsaSignerFactory` using the `public RsaSignerFactory(InputStream privateKeyInputStream, String privateKeyPassword)` constructor to fetch keys from any InputStream.
206207

@@ -420,7 +421,7 @@ public class TokenStorage
420421

421422
**Data Endpoints**
422423

423-
The Xero Java SDK contains XeroClient which has helper methods to perform (Create, Read, Update and Delete) actions on each endpoints. Once you instantiate XeroClient, you'll use Xero API schema classes to interact with Java Objects.
424+
The Xero Java SDK contains Client classes (AccountingApi, AssetsApi, etc) which have helper methods to perform (Create, Read, Update and Delete) actions on each endpoints. Once you instantiate a Client class, you'll use Xero API models to interact with Java Objects.
424425

425426
```java
426427
import com.xero.api.*;

0 commit comments

Comments
 (0)