bkper-js 1.47.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (26) hide show
  1. package/CHANGELOG.md +346 -0
  2. package/README.md +24 -0
  3. package/lib/index.d.ts +891 -402
  4. package/lib/model/Account.js +81 -66
  5. package/lib/model/Agent.js +6 -0
  6. package/lib/model/Amount.js +72 -13
  7. package/lib/model/App.js +77 -26
  8. package/lib/model/BalancesReport.js +11 -5
  9. package/lib/model/Bkper.js +19 -42
  10. package/lib/model/Book.js +164 -94
  11. package/lib/model/BotResponse.js +13 -3
  12. package/lib/model/Collection.js +16 -2
  13. package/lib/model/Connection.js +8 -6
  14. package/lib/model/Conversation.js +9 -2
  15. package/lib/model/Event.js +18 -0
  16. package/lib/model/EventList.js +10 -5
  17. package/lib/model/File.js +31 -12
  18. package/lib/model/Group.js +75 -33
  19. package/lib/model/Integration.js +4 -2
  20. package/lib/model/Message.js +18 -5
  21. package/lib/model/Query.js +18 -4
  22. package/lib/model/Template.js +2 -0
  23. package/lib/model/Transaction.js +165 -93
  24. package/lib/model/TransactionList.js +14 -7
  25. package/lib/model/User.js +7 -1
  26. package/package.json +1 -1
package/CHANGELOG.md ADDED
@@ -0,0 +1,346 @@
1
+ ### **Changelog**
2
+
3
+ See what's new and what has changed in bkper-js
4
+
5
+ 2025
6
+ ----
7
+
8
+ **July 2025**
9
+ * **BREAKING CHANGE:** Refactored `Bkper` class from static methods to constructor-based pattern
10
+ * **BREAKING CHANGE:** Removed deprecated methods: `Transaction.remove()`, `Transaction.restore()`, `Account.getBalance()`, `Account.getBalanceRaw()`
11
+ * **MIGRATION:** Replace `Bkper.setConfig(config); Bkper.getBook(id)` with `const bkper = new Bkper(config); bkper.getBook(id)`
12
+ * **MIGRATION:** Use `transaction.trash()` and `transaction.untrash()` instead of `remove()` and `restore()`
13
+ * **MIGRATION:** Use `Book.getBalancesReport()` instead of `Account.getBalance()` methods
14
+
15
+ **June 2025**
16
+ * Added [Book.copy](/docs/bkper-js/#book_copy)
17
+ * Added [Transaction.getUpdatedAt](/docs/bkper-js/#transaction_getupdatedat)
18
+ * Added [Transaction.getUpdatedAtFormatted](/docs/bkper-js/#transaction_getupdatedatformatted)
19
+
20
+ **May 2025**
21
+ * Added [Group.isLocked](/docs/bkper-js/#group_islocked)
22
+ * Added [Group.setLocked](/docs/bkper-js/#group_setlocked)
23
+ * Added [Message.stream](/docs/bkper-js/#message_stream)
24
+ * Added [Query](/docs/bkper-js/#query)
25
+ * Added [Query.json](/docs/bkper-js/#query_getbook)
26
+ * Added [Query.getId](/docs/bkper-js/#query_getid)
27
+ * Added [Query.getTitle](/docs/bkper-js/#query_gettitle)
28
+ * Added [Query.setTitle](/docs/bkper-js/#query_settitle)
29
+ * Added [Query.getQuery](/docs/bkper-js/#query_getquery)
30
+ * Added [Query.setQuery](/docs/bkper-js/#query_setquery)
31
+ * Added [Query.create](/docs/bkper-js/#query_create)
32
+ * Added [Query.update](/docs/bkper-js/#query_update)
33
+ * Added [Query.remove](/docs/bkper-js/#query_remove)
34
+ * Added [Book.getSavedQueries](/docs/bkper-js/#book_getsavedqueries)
35
+ * Added [Book.batchPostTransactions](/docs/bkper-js/#book_batchposttransactions)
36
+ * Added [Book.batchCheckTransactions](/docs/bkper-js/#book_batchchecktransactions)
37
+ * Added [Book.batchUncheckTransactions](/docs/bkper-js/#book_batchunchecktransactions)
38
+ * Added [Book.batchUpdateTransactions](/docs/bkper-js/#book_batchupdatetransactions)
39
+ * Added [Book.batchUntrashTransactions](/docs/bkper-js/#book_batchuntrashtransactions)
40
+
41
+ **April 2025**
42
+ * Added [Book.batchCreateAccounts](/docs/bkper-js/#book_batchcreateaccounts)
43
+ * Added [Book.batchCreateGroups](/docs/bkper-js/#book_batchcreategroups)
44
+
45
+ **March 2025**
46
+ * Added [Agent.getLogoUrlDark](/docs/bkper-js/#agent_getlogourldark)
47
+ * Added [App.getFilePatterns](/docs/bkper-js/#app_getfilepatterns)
48
+ * Added [App.getLogoUrlDark](/docs/bkper-js/#app_getlogourldark)
49
+ * Added [App.getOwnerLogoUrl](/docs/bkper-js/#app_getownerlogourl)
50
+ * Added [App.getOwnerName](/docs/bkper-js/#app_getownername)
51
+ * Added [App.isConversational](/docs/bkper-js/#app_isconversational)
52
+ * Added [App.isPublished](/docs/bkper-js/#app_ispublished)
53
+ * Added [App.setConversationUrlDev](/docs/bkper-js/#app_setconversationurldev)
54
+ * Added [Bkper.getConversations](/docs/bkper-js/#app_getconversations)
55
+ * Added [Conversation](/docs/bkper-js/#conversation)
56
+ * Added [Conversation.create](/docs/bkper-js/#conversation_create)
57
+ * Added [Conversation.getAgent](/docs/bkper-js/#conversation_getagent)
58
+ * Added [Conversation.getCreatedAt](/docs/bkper-js/#conversation_getcreatedat)
59
+ * Added [Conversation.getId](/docs/bkper-js/#conversation_getid)
60
+ * Added [Conversation.getMessages](/docs/bkper-js/#conversation_getmessages)
61
+ * Added [Conversation.getTitle](/docs/bkper-js/#conversation_gettitle)
62
+ * Added [Conversation.getUpdatedAt](/docs/bkper-js/#conversation_getupdatedat)
63
+ * Added [Conversation.json](/docs/bkper-js/#conversation_json)
64
+ * Added [Message](/docs/bkper-js/#message)
65
+ * Added [Message.create](/docs/bkper-js/#message_create)
66
+ * Added [Message.deleteProperty](/docs/bkper-js/#message_deleteproperty)
67
+ * Added [Message.getAgent](/docs/bkper-js/#message_getagent)
68
+ * Added [Message.getCreatedAt](/docs/bkper-js/#message_getcreatedat)
69
+ * Added [Message.getContent](/docs/bkper-js/#message_getcontent)
70
+ * Added [Message.getConversation](/docs/bkper-js/#message_getconversation)
71
+ * Added [Message.getId](/docs/bkper-js/#message_getid)
72
+ * Added [Message.getProperties](/docs/bkper-js/#message_getproperties)
73
+ * Added [Message.getProperty](/docs/bkper-js/#message_getproperty)
74
+ * Added [Message.getUser](/docs/bkper-js/#message_getuser)
75
+ * Added [Message.setContent](/docs/bkper-js/#message_setcontent)
76
+ * Added [Message.setProperties](/docs/bkper-js/#message_setproperties)
77
+ * Added [Message.setProperty](/docs/bkper-js/#message_setproperty)
78
+ * Added [Message.json](/docs/bkper-js/#message_json)
79
+ * Added [Transaction.getAgentName](/docs/bkper-js/#transaction_getagentname)
80
+ * Added [Transaction.getAgentLogoUrl](/docs/bkper-js/#transaction_getagentlogourl)
81
+ * Added [Transaction.getAgentLogoUrlDark](/docs/bkper-js/#transaction_getagentlogourldark)
82
+
83
+ **February 2025**
84
+ * Added [EventType](/docs/bkper-js/#eventtype) enum
85
+ * Added [BotResponseType](/docs/bkper-js/#botresponsetype) enum
86
+ * Added [Agent](/docs/bkper-js/#agent)
87
+ * Added [Agent.getId](/docs/bkper-js/#agent_getid)
88
+ * Added [Agent.getLogoUrl](/docs/bkper-js/#agent_getlogourl)
89
+ * Added [Agent.getName](/docs/bkper-js/#agent_getname)
90
+ * Added [Agent.json](/docs/bkper-js/#agent_json)
91
+ * Added [App.getDescription](/docs/bkper-js/#app_getdescription)
92
+ * Added [App.getEvents](/docs/bkper-js/#app_getevents)
93
+ * Added [App.getLogoUrl](/docs/bkper-js/#app_getlogourl)
94
+ * Added [App.getName](/docs/bkper-js/#app_getname)
95
+ * Added [App.hasEvents](/docs/bkper-js/#app_hasevents)
96
+ * Added [Book.batchReplayEvents](/docs/bkper-js/#book_batchreplayevents)
97
+ * Added [Book.getApps](/docs/bkper-js/#book_getapps)
98
+ * Added [BotResponse](/docs/bkper-js/#botresponse)
99
+ * Added [BotResponse.getAgentId](/docs/bkper-js/#botresponse_getagentid)
100
+ * Added [BotResponse.getCreatedAt](/docs/bkper-js/#botresponse_getcreatedat)
101
+ * Added [BotResponse.getEvent](/docs/bkper-js/#botresponse_getevent)
102
+ * Added [BotResponse.getMessage](/docs/bkper-js/#botresponse_getmessage)
103
+ * Added [BotResponse.getType](/docs/bkper-js/#botresponse_gettype)
104
+ * Added [BotResponse.remove](/docs/bkper-js/#botresponse_remove)
105
+ * Added [BotResponse.replay](/docs/bkper-js/#botresponse_replay)
106
+ * Added [Event.getAgent](/docs/bkper-js/#event_getagent)
107
+ * Added [Event.getBook](/docs/bkper-js/#event_getbook)
108
+ * Added [Event.getBotResponses](/docs/bkper-js/#event_getbotresponses)
109
+ * Added [Event.getCreatedAt](/docs/bkper-js/#event_getcreatedat)
110
+ * Added [Event.getId](/docs/bkper-js/#event_getid)
111
+ * Added [Event.getType](/docs/bkper-js/#event_gettype)
112
+ * Added [Event.getUser](/docs/bkper-js/#event_getuser)
113
+ * Added [Event.hasErrorResponse](/docs/bkper-js/#event_haserrorresponse)
114
+ * Added [User.getAvatarUrl](/docs/bkper-js/#user_getavatarurl)
115
+
116
+ **January 2025**
117
+ * Added [BalancesContainer](/docs/bkper-js/#balancescontainer)
118
+ * Added [BalancesContainer.getName](/docs/bkper-js/#balancescontainer_getname)
119
+ * Added [BalancesContainer.getNormalizedName](/docs/bkper-js/#balancescontainer_getnormalizedname)
120
+ * Added [BalancesContainer.getGroup](/docs/bkper-js/#balancescontainer_getgroup)
121
+ * Added [BalancesContainer.getAccount](/docs/bkper-js/#balancescontainer_getaccount)
122
+ * Added [BalancesContainer.getParent](/docs/bkper-js/#balancescontainer_getparent)
123
+ * Added [BalancesContainer.getDepth](/docs/bkper-js/#balancescontainer_getdepth)
124
+ * Added [BalancesContainer.isCredit](/docs/bkper-js/#balancescontainer_iscredit)
125
+ * Added [BalancesContainer.isPermanent](/docs/bkper-js/#balancescontainer_ispermanent)
126
+ * Added [BalancesContainer.isFromAccount](/docs/bkper-js/#balancescontainer_isfromaccount)
127
+ * Added [BalancesContainer.isFromGroup](/docs/bkper-js/#balancescontainer_isfromgroup)
128
+ * Added [BalancesContainer.hasGroupBalances](/docs/bkper-js/#balancescontainer_hasgroupbalances)
129
+ * Added [BalancesContainer.getCumulativeBalance](/docs/bkper-js/#balancescontainer_getcumulativebalance)
130
+ * Added [BalancesContainer.getCumulativeBalanceRaw](/docs/bkper-js/#balancescontainer_getcumulativebalanceraw)
131
+ * Added [BalancesContainer.getCumulativeBalanceText](/docs/bkper-js/#balancescontainer_getcumulativebalancetext)
132
+ * Added [BalancesContainer.getCumulativeBalanceRawText](/docs/bkper-js/#balancescontainer_getcumulativebalancerawtext)
133
+ * Added [BalancesContainer.getPeriodBalance](/docs/bkper-js/#balancescontainer_getperiodbalance)
134
+ * Added [BalancesContainer.getPeriodBalanceRaw](/docs/bkper-js/#balancescontainer_getperiodbalanceraw)
135
+ * Added [BalancesContainer.getPeriodBalanceText](/docs/bkper-js/#balancescontainer_getperiodbalancetext)
136
+ * Added [BalancesContainer.getPeriodBalanceRawText](/docs/bkper-js/#balancescontainer_getperiodbalancerawtext)
137
+ * Added [BalancesContainer.getBalancesContainers](/docs/bkper-js/#balancescontainer_getbalancescontainers)
138
+ * Added [BalancesContainer.getBalancesContainer](/docs/bkper-js/#balancescontainer_getbalancescontainer)
139
+ * Added [BalancesReport](/docs/bkper-js/#balancesreport)
140
+ * Added [BalancesReport.getBook](/docs/bkper-js/#balancesreport_getbook)
141
+ * Added [BalancesReport.getPeriod](/docs/bkper-js/#balancesreport_getperiod)
142
+ * Added [BalancesReport.getBalancesContainers](/docs/bkper-js/#balancesreport_getbalancescontainers)
143
+ * Added [BalancesReport.getBalancesContainer](/docs/bkper-js/#balancesreport_getbalancescontainer)
144
+ * Added [Book.getAutoPost](/docs/bkper-js/#book_getautopost)
145
+ * Added [Book.setAutoPost](/docs/bkper-js/#book_setautopost)
146
+ * Added [Group.isCredit](/docs/bkper-js/#group_iscredit)
147
+ * Added [Group.isMixed](/docs/bkper-js/#group_ismixed)
148
+ * Added [User.getPlan](/docs/bkper-js/#user_getplan)
149
+ * Added [User.hasBillingEnabled](/docs/bkper-js/#user_hasbillingenabled)
150
+
151
+
152
+ 2024
153
+ ----
154
+
155
+ **December 2024**
156
+ * Added [Book.listEvents](/docs/bkper-js/#book_listevents)
157
+ * Added [EventList](/docs/bkper-js/#eventlist)
158
+ * Added [EventList.getCursor](/docs/bkper-js/#eventlist_getcursor)
159
+ * Added [EventList.getFirst](/docs/bkper-js/#eventlist_getfirst)
160
+ * Added [EventList.getItems](/docs/bkper-js/#eventlist_getitems)
161
+ * Added [EventList.size](/docs/bkper-js/#eventlist_size)
162
+ * Added [Group.isPermanent](/docs/bkper-js/#group_ispermanent)
163
+ * Added [Group.hasParent](/docs/bkper-js/#group_hasparent)
164
+ * Added [Group.getChildren](/docs/bkper-js/#group_getchildren)
165
+ * Added [Group.getDescendants](/docs/bkper-js/#group_getdescendants)
166
+ * Added [Group.getDescendantTreeIds](/docs/bkper-js/#group_getdescendanttreeids)
167
+ * Added [Group.hasChildren](/docs/bkper-js/#group_haschildren)
168
+ * Added [Group.isLeaf](/docs/bkper-js/#group_isleaf)
169
+ * Added [Group.isRoot](/docs/bkper-js/#group_isroot)
170
+ * Added [Group.getDepth](/docs/bkper-js/#group_getdepth)
171
+ * Added [Group.getRoot](/docs/bkper-js/#group_getroot)
172
+ * Added [Group.getRootName](/docs/bkper-js/#group_getrootname)
173
+ * Added [Group.hasAccounts](/docs/bkper-js/#group_hasaccounts)
174
+
175
+ **November 2024**
176
+ * Added [Transaction.trash](/docs/bkper-js/#transaction_trash)
177
+ * Added [Transaction.untrash](/docs/bkper-js/#transaction_untrash)
178
+ * Added [Transaction.getAmountFormatted](/docs/bkper-js/#transaction_getamountformatted)
179
+ * Added [Transaction.isLocked](/docs/bkper-js/#transaction_islocked)
180
+ * Removed ```Transaction.remove``` from [Transaction](/docs/bkper-js/#transaction)
181
+ * Removed ```Transaction.restore``` from [Transaction](/docs/bkper-js/#transaction)
182
+
183
+ **October 2024**
184
+ * Exposed ```payload``` property on all objects from [bkper-js](/docs/bkper-js) interface
185
+ * Added [Collection.addBooks](/docs/bkper-js/#collection_addbooks)
186
+ * Added [Collection.create](/docs/bkper-js/#collection_create)
187
+ * Added [Collection.getOwnerUsername](/docs/bkper-js/#collection_getownerusername)
188
+ * Added [Collection.getPermission](/docs/bkper-js/#collection_getpermission)
189
+ * Added [Collection.getUpdatedAt](/docs/bkper-js/#collection_getupdatedat)
190
+ * Added [Collection.remove](/docs/bkper-js/#collection_remove)
191
+ * Added [Collection.removeBooks](/docs/bkper-js/#collection_removebooks)
192
+ * Added [Collection.setName](/docs/bkper-js/#collection_setname)
193
+ * Added [Collection.update](/docs/bkper-js/#collection_update)
194
+ * Added [Bkper.getBillingPortalUrl](/docs/bkper-js/#bkper_getbillingportalurl)
195
+ * Added [Connection.getDateAddedMs](/docs/bkper-js/#connection_getdateaddedms)
196
+ * Added [Connection.getLogo](/docs/bkper-js/#connection_getlogo)
197
+ * Added [Connection.remove](/docs/bkper-js/#connection_remove)
198
+ * Added [Integration.getAddedBy](/docs/bkper-js/#integration_getaddedby)
199
+ * Added [Integration.getAgentId](/docs/bkper-js/#integration_getagentid)
200
+ * Added [Integration.getDateAddedMs](/docs/bkper-js/#integration_getdateaddedms)
201
+ * Added [Integration.getLastUpdateMs](/docs/bkper-js/#integration_getlastupdatems)
202
+ * Added [Integration.getLogo](/docs/bkper-js/#integration_getlogo)
203
+ * Added [Integration.remove](/docs/bkper-js/#integration_remove)
204
+ * Added [TransactionList](/docs/bkper-js/#transactionlist) returned from [Book.listTransactions](/docs/bkper-js/#book_listtransactions)
205
+ * Removed ```TransactionIterator``` from [Transaction](/docs/bkper-js/#transaction)
206
+ * Removed ```newTransaction``` from [Book](/docs/bkper-js/#book). Use [Transaction](/docs/bkper-js/#transaction) constructor instead
207
+ * Removed ```newAccount``` from [Book](/docs/bkper-js/#book). Use [Account](/docs/bkper-js/#account) constructor instead
208
+ * Removed ```newGroup``` from [Book](/docs/bkper-js/#book). Use [Group](/docs/bkper-js/#group) constructor instead
209
+ * Removed ```newFile``` from [Book](/docs/bkper-js/#book). Use [File](/docs/bkper-js/#file) constructor instead
210
+
211
+ **September 2024**
212
+ * Extracted [bkper-js](https://github.com/bkper/bkper-js) from [bkper](https://github.com/bkper/bkper-node) as a standalone library.
213
+ * Added [Config.requestRetryHandler](/docs/bkper-js/#config_requestretryhandler)
214
+ * Added [Visibility](/docs/bkper-js/#visibility) enum
215
+ * Added [App.json](/docs/bkper-js/#app_json)
216
+ * Added [Bkper.getApps](/docs/bkper-js/#bkper_getapps)
217
+ * Added [Bkper.getBooks](/docs/bkper-js/#bkper_getbooks)
218
+ * Added [Bkper.getTemplates](/docs/bkper-js/#bkper_gettemplates)
219
+ * Added [Bkper.newBook](/docs/bkper-js/#bkper_newbook)
220
+ * Added [Book.getTotalTransactions](/docs/bkper-js/#book_gettotaltransactions)
221
+ * Added [Book.getTotalTransactionsCurrentMonth](/docs/bkper-js/#book_gettotaltransactionscurrentmonth)
222
+ * Added [Book.getTotalTransactionsCurrentYear](/docs/bkper-js/#book_gettotaltransactionscurrentyear)
223
+ * Added [Book.getVisibility](/docs/bkper-js/#book_getvisibility)
224
+ * Added [Book.create](/docs/bkper-js/#book_create)
225
+ * Added [Collection.json](/docs/bkper-js/#collection_json)
226
+ * Added [Template](/docs/bkper-js/#template)
227
+ * Added [Template.getBookId](/docs/bkper-js/#template_getbookid)
228
+ * Added [Template.getBookLink](/docs/bkper-js/#template_getbooklink)
229
+ * Added [Template.getCategory](/docs/bkper-js/#template_getcategory)
230
+ * Added [Template.getDescription](/docs/bkper-js/#template_getdescription)
231
+ * Added [Template.getImageUrl](/docs/bkper-js/#template_getimageurl)
232
+ * Added [Template.getName](/docs/bkper-js/#template_getname)
233
+ * Added [Template.getSheetsLink](/docs/bkper-js/#template_getsheetslink)
234
+ * Added [Template.getTimesUsed](/docs/bkper-js/#template_gettimesused)
235
+ * Added [Template.json](/docs/bkper-js/#template_json)
236
+ * Added [User.getEmail](/docs/bkper-js/#user_getemail)
237
+ * Added [User.getHostedDomain](/docs/bkper-js/#user_gethosteddomain)
238
+ * Added [User.isFree](/docs/bkper-js/#user_isfree)
239
+ * Added [User.hasStartedTrial](/docs/bkper-js/#user_hasstartedtrial)
240
+ * Added [User.getDaysLeftInTrial](/docs/bkper-js/#user_getdaysleftintrial)
241
+ * Added [User.hasUsedConnections](/docs/bkper-js/#user_hasusedconnections)
242
+ * Added [User.json](/docs/bkper-js/#user_json)
243
+
244
+ **January 2024**
245
+ * Added [Transaction.setChecked](/docs/bkper-js/#transaction_setchecked)
246
+
247
+
248
+ 2023
249
+ ----
250
+
251
+ **June 2023**
252
+ * Added [Bkper.getUser](/docs/bkper-js/#bkper_getuser)
253
+ * Added [Bkper.setConfig](/docs/bkper-js/#bkper_setconfig)
254
+ * Added [Book.batchTrashTransactions](/docs/bkper-js/#book_batchtrashtransactions)
255
+ * Added [Book.createIntegration](/docs/bkper-js/#book_createintegration)
256
+ * Added [Book.getIntegrations](/docs/bkper-js/#book_getintegrations)
257
+ * Added [Book.updateIntegration](/docs/bkper-js/#book_updateintegration)
258
+ * Added [Config](/docs/bkper-js/#config) interface
259
+ * Added [Connection](/docs/bkper-js/#connection)
260
+ * Added [Connection.clearTokenProperties](/docs/bkper-js/#connection_cleartokenproperties)
261
+ * Added [Connection.create](/docs/bkper-js/#connection_create)
262
+ * Added [Connection.deleteProperty](/docs/bkper-js/#connection_deleteproperty)
263
+ * Added [Connection.getAgentId](/docs/bkper-js/#connection_getagentid)
264
+ * Added [Connection.getEmail](/docs/bkper-js/#connection_getemail)
265
+ * Added [Connection.getId](/docs/bkper-js/#connection_getid)
266
+ * Added [Connection.getIntegrations](/docs/bkper-js/#connection_getintegrations)
267
+ * Added [Connection.getName](/docs/bkper-js/#connection_getname)
268
+ * Added [Connection.getProperties](/docs/bkper-js/#connection_getproperties)
269
+ * Added [Connection.getProperty](/docs/bkper-js/#connection_getproperty)
270
+ * Added [Connection.getPropertyKeys](/docs/bkper-js/#connection_getpropertykeys)
271
+ * Added [Connection.getType](/docs/bkper-js/#connection_gettype)
272
+ * Added [Connection.getUUID](/docs/bkper-js/#connection_getuuid)
273
+ * Added [Connection.json](/docs/bkper-js/#connection_json)
274
+ * Added [Connection.setAgentId](/docs/bkper-js/#connection_setagentid)
275
+ * Added [Connection.setName](/docs/bkper-js/#connection_setname)
276
+ * Added [Connection.setProperties](/docs/bkper-js/#connection_setproperties)
277
+ * Added [Connection.setProperty](/docs/bkper-js/#connection_setproperty)
278
+ * Added [Connection.setType](/docs/bkper-js/#connection_settype)
279
+ * Added [Connection.setUUID](/docs/bkper-js/#connection_setuuid)
280
+ * Added [Integration](/docs/bkper-js/#integration)
281
+ * Added [Integration.deleteProperty](/docs/bkper-js/#integration_deleteproperty)
282
+ * Added [Integration.getBookId](/docs/bkper-js/#integration_getbookid)
283
+ * Added [Integration.getId](/docs/bkper-js/#integration_getid)
284
+ * Added [Integration.getName](/docs/bkper-js/#integration_getname)
285
+ * Added [Integration.getProperties](/docs/bkper-js/#integration_getproperties)
286
+ * Added [Integration.getProperty](/docs/bkper-js/#integration_getproperty)
287
+ * Added [Integration.json](/docs/bkper-js/#integration_json)
288
+ * Added [Integration.setProperties](/docs/bkper-js/#integration_setproperties)
289
+ * Added [Integration.setProperty](/docs/bkper-js/#integration_setproperty)
290
+ * Added [User](/docs/bkper-js/#user)
291
+ * Added [User.getConnection](/docs/bkper-js/#user_getconnection)
292
+ * Added [User.getConnections](/docs/bkper-js/#user_getconnections)
293
+ * Added [User.getFullName](/docs/bkper-js/#user_getfullname)
294
+ * Added [User.getId](/docs/bkper-js/#user_getid)
295
+ * Added [User.getName](/docs/bkper-js/#user_getname)
296
+ * Deprecated [Bkper.setApiKey](/docs/bkper-js/#bkper_setapikey)
297
+ * Deprecated [Bkper.setOAuthTokenProvider](/docs/bkper-js/#bkper_setoauthtokenprovider)
298
+
299
+
300
+ 2022
301
+ ----
302
+
303
+ **September 2022**
304
+ * Deprecated [Account.getBalance](/docs/bkper-js/#account_getbalance)
305
+
306
+ **May 2022**
307
+ * Added [Book.parseDate](/docs/bkper-js/#book_parsedate)
308
+
309
+ **April 2022**
310
+ * Added [Book.getClosingDate](/docs/bkper-js/#book_getclosingdate)
311
+ * Added [Book.setClosingDate](/docs/bkper-js/#book_setclosingdate)
312
+
313
+
314
+ 2021
315
+ ----
316
+
317
+ **October 2021**
318
+ * Added [Book.getGroupsByAccount](/docs/bkper-js/#book_getgroupsbyaccount)
319
+
320
+ **May 2021**
321
+ * Added [Group.getParent](/docs/bkper-js/#group_getparent)
322
+ * Added [Group.setParent](/docs/bkper-js/#group_setparent)
323
+ * **BREAKING CHANGE:** Removed **AccountsDataTableBuilder**
324
+ * **BREAKING CHANGE:** Removed **BalancesDataTableBuilder**
325
+ * **BREAKING CHANGE:** Removed **TransactionsDataTableBuilder**
326
+ * **BREAKING CHANGE:** Removed **BalancesReport**
327
+ * **BREAKING CHANGE:** Removed **Balance**
328
+ * **BREAKING CHANGE:** Removed **BalancesContainer**
329
+
330
+ **April 2021**
331
+ * Added [Book.getLockDate](/docs/bkper-js/#book_getlockdate)
332
+ * Added [Book.setLockDate](/docs/bkper-js/#book_setlockdate)
333
+
334
+ **March 2021**
335
+ * **BREAKING CHANGE:** : Removed **BalanceCheckedType**
336
+
337
+ **February 2021**
338
+ * Added [Book.getPeriod](/docs/bkper-js/#book_getperiod)
339
+ * Added [Book.setPeriod](/docs/bkper-js/#book_setperiod)
340
+ * Added [Book.getPeriodStartMonth](/docs/bkper-js/#book_getperiodstartmonth)
341
+ * Added [Book.setPeriodStartMonth](/docs/bkper-js/#book_setperiodstartmonth)
342
+ * Added [Book.getPageSize](/docs/bkper-js/#book_getpagesize)
343
+ * Added [Book.setPageSize](/docs/bkper-js/#book_setpagesize)
344
+
345
+ **January 2021**
346
+ * [bkper](https://www.npmjs.com/package/bkper) client library published
package/README.md CHANGED
@@ -27,4 +27,28 @@ or
27
27
  bun add bkper-js
28
28
  ```
29
29
 
30
+ ## Usage
31
+
32
+ ```typescript
33
+ import { Bkper } from 'bkper-js';
34
+
35
+ // Create Bkper instance with configuration
36
+ const bkper = new Bkper({
37
+ apiKeyProvider: () => process.env.BKPER_API_KEY,
38
+ oauthTokenProvider: () => process.env.BKPER_OAUTH_TOKEN
39
+ });
40
+
41
+ // Get a book and work with it
42
+ const book = await bkper.getBook('your-book-id');
43
+ console.log(`Book: ${book.getName()}`);
44
+
45
+ // List all books
46
+ const books = await bkper.getBooks();
47
+ console.log(`You have ${books.length} books`);
48
+
49
+ // Get current user
50
+ const user = await bkper.getUser();
51
+ console.log(`Logged in as: ${user.getName()}`);
52
+ ```
53
+
30
54