bkper-js 2.1.0 → 2.2.1

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