bkper-js 2.2.0 → 2.2.2

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.
package/CHANGELOG.md CHANGED
@@ -6,344 +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
13
- * Added [Balance](/docs/bkper-js/#balance) class back for improved balance reporting
14
- * Added [BalancesDataTableBuilder](/docs/bkper-js/#balancesdatatablebuilder) for building balance data tables
15
- * Added [BalanceType](/docs/bkper-js/#balancetype) enum with TOTAL, PERIOD, and CUMULATIVE options
16
- * Updated `Book.getDatePattern()` to return default pattern 'dd/MM/yyyy' when not set
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
+
17
18
 
18
19
  **June 2025**
19
- * Added [Book.copy](/docs/bkper-js/#book_copy)
20
- * Added [Transaction.getUpdatedAt](/docs/bkper-js/#transaction_getupdatedat)
21
- * Added [Transaction.getUpdatedAtFormatted](/docs/bkper-js/#transaction_getupdatedatformatted)
20
+ * Added `Book.copy`
21
+ * Added `Transaction.getUpdatedAt`
22
+ * Added `Transaction.getUpdatedAtFormatted`
22
23
 
23
24
  **May 2025**
24
- * Added [Group.isLocked](/docs/bkper-js/#group_islocked)
25
- * Added [Group.setLocked](/docs/bkper-js/#group_setlocked)
26
- * Added [Message.stream](/docs/bkper-js/#message_stream)
27
- * Added [Query](/docs/bkper-js/#query)
28
- * Added [Query.json](/docs/bkper-js/#query_getbook)
29
- * Added [Query.getId](/docs/bkper-js/#query_getid)
30
- * Added [Query.getTitle](/docs/bkper-js/#query_gettitle)
31
- * Added [Query.setTitle](/docs/bkper-js/#query_settitle)
32
- * Added [Query.getQuery](/docs/bkper-js/#query_getquery)
33
- * Added [Query.setQuery](/docs/bkper-js/#query_setquery)
34
- * Added [Query.create](/docs/bkper-js/#query_create)
35
- * Added [Query.update](/docs/bkper-js/#query_update)
36
- * Added [Query.remove](/docs/bkper-js/#query_remove)
37
- * Added [Book.getSavedQueries](/docs/bkper-js/#book_getsavedqueries)
38
- * Added [Book.batchPostTransactions](/docs/bkper-js/#book_batchposttransactions)
39
- * Added [Book.batchCheckTransactions](/docs/bkper-js/#book_batchchecktransactions)
40
- * Added [Book.batchUncheckTransactions](/docs/bkper-js/#book_batchunchecktransactions)
41
- * Added [Book.batchUpdateTransactions](/docs/bkper-js/#book_batchupdatetransactions)
42
- * 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`
43
44
 
44
45
  **April 2025**
45
- * Added [Book.batchCreateAccounts](/docs/bkper-js/#book_batchcreateaccounts)
46
- * Added [Book.batchCreateGroups](/docs/bkper-js/#book_batchcreategroups)
46
+ * Added `Book.batchCreateAccounts`
47
+ * Added `Book.batchCreateGroups`
47
48
 
48
49
  **March 2025**
49
- * Added [Agent.getLogoUrlDark](/docs/bkper-js/#agent_getlogourldark)
50
- * Added [App.getFilePatterns](/docs/bkper-js/#app_getfilepatterns)
51
- * Added [App.getLogoUrlDark](/docs/bkper-js/#app_getlogourldark)
52
- * Added [App.getOwnerLogoUrl](/docs/bkper-js/#app_getownerlogourl)
53
- * Added [App.getOwnerName](/docs/bkper-js/#app_getownername)
54
- * Added [App.isConversational](/docs/bkper-js/#app_isconversational)
55
- * Added [App.isPublished](/docs/bkper-js/#app_ispublished)
56
- * Added [App.setConversationUrlDev](/docs/bkper-js/#app_setconversationurldev)
57
- * Added [Bkper.getConversations](/docs/bkper-js/#app_getconversations)
58
- * Added [Conversation](/docs/bkper-js/#conversation)
59
- * Added [Conversation.create](/docs/bkper-js/#conversation_create)
60
- * Added [Conversation.getAgent](/docs/bkper-js/#conversation_getagent)
61
- * Added [Conversation.getCreatedAt](/docs/bkper-js/#conversation_getcreatedat)
62
- * Added [Conversation.getId](/docs/bkper-js/#conversation_getid)
63
- * Added [Conversation.getMessages](/docs/bkper-js/#conversation_getmessages)
64
- * Added [Conversation.getTitle](/docs/bkper-js/#conversation_gettitle)
65
- * Added [Conversation.getUpdatedAt](/docs/bkper-js/#conversation_getupdatedat)
66
- * Added [Conversation.json](/docs/bkper-js/#conversation_json)
67
- * Added [Message](/docs/bkper-js/#message)
68
- * Added [Message.create](/docs/bkper-js/#message_create)
69
- * Added [Message.deleteProperty](/docs/bkper-js/#message_deleteproperty)
70
- * Added [Message.getAgent](/docs/bkper-js/#message_getagent)
71
- * Added [Message.getCreatedAt](/docs/bkper-js/#message_getcreatedat)
72
- * Added [Message.getContent](/docs/bkper-js/#message_getcontent)
73
- * Added [Message.getConversation](/docs/bkper-js/#message_getconversation)
74
- * Added [Message.getId](/docs/bkper-js/#message_getid)
75
- * Added [Message.getProperties](/docs/bkper-js/#message_getproperties)
76
- * Added [Message.getProperty](/docs/bkper-js/#message_getproperty)
77
- * Added [Message.getUser](/docs/bkper-js/#message_getuser)
78
- * Added [Message.setContent](/docs/bkper-js/#message_setcontent)
79
- * Added [Message.setProperties](/docs/bkper-js/#message_setproperties)
80
- * Added [Message.setProperty](/docs/bkper-js/#message_setproperty)
81
- * Added [Message.json](/docs/bkper-js/#message_json)
82
- * Added [Transaction.getAgentName](/docs/bkper-js/#transaction_getagentname)
83
- * Added [Transaction.getAgentLogoUrl](/docs/bkper-js/#transaction_getagentlogourl)
84
- * 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`
85
86
 
86
87
  **February 2025**
87
- * Added [EventType](/docs/bkper-js/#eventtype) enum
88
- * Added [BotResponseType](/docs/bkper-js/#botresponsetype) enum
89
- * Added [Agent](/docs/bkper-js/#agent)
90
- * Added [Agent.getId](/docs/bkper-js/#agent_getid)
91
- * Added [Agent.getLogoUrl](/docs/bkper-js/#agent_getlogourl)
92
- * Added [Agent.getName](/docs/bkper-js/#agent_getname)
93
- * Added [Agent.json](/docs/bkper-js/#agent_json)
94
- * Added [App.getDescription](/docs/bkper-js/#app_getdescription)
95
- * Added [App.getEvents](/docs/bkper-js/#app_getevents)
96
- * Added [App.getLogoUrl](/docs/bkper-js/#app_getlogourl)
97
- * Added [App.getName](/docs/bkper-js/#app_getname)
98
- * Added [App.hasEvents](/docs/bkper-js/#app_hasevents)
99
- * Added [Book.batchReplayEvents](/docs/bkper-js/#book_batchreplayevents)
100
- * Added [Book.getApps](/docs/bkper-js/#book_getapps)
101
- * Added [BotResponse](/docs/bkper-js/#botresponse)
102
- * Added [BotResponse.getAgentId](/docs/bkper-js/#botresponse_getagentid)
103
- * Added [BotResponse.getCreatedAt](/docs/bkper-js/#botresponse_getcreatedat)
104
- * Added [BotResponse.getEvent](/docs/bkper-js/#botresponse_getevent)
105
- * Added [BotResponse.getMessage](/docs/bkper-js/#botresponse_getmessage)
106
- * Added [BotResponse.getType](/docs/bkper-js/#botresponse_gettype)
107
- * Added [BotResponse.remove](/docs/bkper-js/#botresponse_remove)
108
- * Added [BotResponse.replay](/docs/bkper-js/#botresponse_replay)
109
- * Added [Event.getAgent](/docs/bkper-js/#event_getagent)
110
- * Added [Event.getBook](/docs/bkper-js/#event_getbook)
111
- * Added [Event.getBotResponses](/docs/bkper-js/#event_getbotresponses)
112
- * Added [Event.getCreatedAt](/docs/bkper-js/#event_getcreatedat)
113
- * Added [Event.getId](/docs/bkper-js/#event_getid)
114
- * Added [Event.getType](/docs/bkper-js/#event_gettype)
115
- * Added [Event.getUser](/docs/bkper-js/#event_getuser)
116
- * Added [Event.hasErrorResponse](/docs/bkper-js/#event_haserrorresponse)
117
- * 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`
118
119
 
119
120
  **January 2025**
120
- * Added [BalancesContainer](/docs/bkper-js/#balancescontainer)
121
- * Added [BalancesContainer.getName](/docs/bkper-js/#balancescontainer_getname)
122
- * Added [BalancesContainer.getNormalizedName](/docs/bkper-js/#balancescontainer_getnormalizedname)
123
- * Added [BalancesContainer.getGroup](/docs/bkper-js/#balancescontainer_getgroup)
124
- * Added [BalancesContainer.getAccount](/docs/bkper-js/#balancescontainer_getaccount)
125
- * Added [BalancesContainer.getParent](/docs/bkper-js/#balancescontainer_getparent)
126
- * Added [BalancesContainer.getDepth](/docs/bkper-js/#balancescontainer_getdepth)
127
- * Added [BalancesContainer.isCredit](/docs/bkper-js/#balancescontainer_iscredit)
128
- * Added [BalancesContainer.isPermanent](/docs/bkper-js/#balancescontainer_ispermanent)
129
- * Added [BalancesContainer.isFromAccount](/docs/bkper-js/#balancescontainer_isfromaccount)
130
- * Added [BalancesContainer.isFromGroup](/docs/bkper-js/#balancescontainer_isfromgroup)
131
- * Added [BalancesContainer.hasGroupBalances](/docs/bkper-js/#balancescontainer_hasgroupbalances)
132
- * Added [BalancesContainer.getCumulativeBalance](/docs/bkper-js/#balancescontainer_getcumulativebalance)
133
- * Added [BalancesContainer.getCumulativeBalanceRaw](/docs/bkper-js/#balancescontainer_getcumulativebalanceraw)
134
- * Added [BalancesContainer.getCumulativeBalanceText](/docs/bkper-js/#balancescontainer_getcumulativebalancetext)
135
- * Added [BalancesContainer.getCumulativeBalanceRawText](/docs/bkper-js/#balancescontainer_getcumulativebalancerawtext)
136
- * Added [BalancesContainer.getPeriodBalance](/docs/bkper-js/#balancescontainer_getperiodbalance)
137
- * Added [BalancesContainer.getPeriodBalanceRaw](/docs/bkper-js/#balancescontainer_getperiodbalanceraw)
138
- * Added [BalancesContainer.getPeriodBalanceText](/docs/bkper-js/#balancescontainer_getperiodbalancetext)
139
- * Added [BalancesContainer.getPeriodBalanceRawText](/docs/bkper-js/#balancescontainer_getperiodbalancerawtext)
140
- * Added [BalancesContainer.getBalancesContainers](/docs/bkper-js/#balancescontainer_getbalancescontainers)
141
- * Added [BalancesContainer.getBalancesContainer](/docs/bkper-js/#balancescontainer_getbalancescontainer)
142
- * Added [BalancesReport](/docs/bkper-js/#balancesreport)
143
- * Added [BalancesReport.getBook](/docs/bkper-js/#balancesreport_getbook)
144
- * Added [BalancesReport.getPeriod](/docs/bkper-js/#balancesreport_getperiod)
145
- * Added [BalancesReport.getBalancesContainers](/docs/bkper-js/#balancesreport_getbalancescontainers)
146
- * Added [BalancesReport.getBalancesContainer](/docs/bkper-js/#balancesreport_getbalancescontainer)
147
- * Added [Book.getAutoPost](/docs/bkper-js/#book_getautopost)
148
- * Added [Book.setAutoPost](/docs/bkper-js/#book_setautopost)
149
- * Added [Group.isCredit](/docs/bkper-js/#group_iscredit)
150
- * Added [Group.isMixed](/docs/bkper-js/#group_ismixed)
151
- * Added [User.getPlan](/docs/bkper-js/#user_getplan)
152
- * 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`
153
154
 
154
155
 
155
156
  2024
156
157
  ----
157
158
 
158
159
  **December 2024**
159
- * Added [Book.listEvents](/docs/bkper-js/#book_listevents)
160
- * Added [EventList](/docs/bkper-js/#eventlist)
161
- * Added [EventList.getCursor](/docs/bkper-js/#eventlist_getcursor)
162
- * Added [EventList.getFirst](/docs/bkper-js/#eventlist_getfirst)
163
- * Added [EventList.getItems](/docs/bkper-js/#eventlist_getitems)
164
- * Added [EventList.size](/docs/bkper-js/#eventlist_size)
165
- * Added [Group.isPermanent](/docs/bkper-js/#group_ispermanent)
166
- * Added [Group.hasParent](/docs/bkper-js/#group_hasparent)
167
- * Added [Group.getChildren](/docs/bkper-js/#group_getchildren)
168
- * Added [Group.getDescendants](/docs/bkper-js/#group_getdescendants)
169
- * Added [Group.getDescendantTreeIds](/docs/bkper-js/#group_getdescendanttreeids)
170
- * Added [Group.hasChildren](/docs/bkper-js/#group_haschildren)
171
- * Added [Group.isLeaf](/docs/bkper-js/#group_isleaf)
172
- * Added [Group.isRoot](/docs/bkper-js/#group_isroot)
173
- * Added [Group.getDepth](/docs/bkper-js/#group_getdepth)
174
- * Added [Group.getRoot](/docs/bkper-js/#group_getroot)
175
- * Added [Group.getRootName](/docs/bkper-js/#group_getrootname)
176
- * 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`
177
178
 
178
179
  **November 2024**
179
- * Added [Transaction.trash](/docs/bkper-js/#transaction_trash)
180
- * Added [Transaction.untrash](/docs/bkper-js/#transaction_untrash)
181
- * Added [Transaction.getAmountFormatted](/docs/bkper-js/#transaction_getamountformatted)
182
- * Added [Transaction.isLocked](/docs/bkper-js/#transaction_islocked)
183
- * Removed ```Transaction.remove``` from [Transaction](/docs/bkper-js/#transaction)
184
- * 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`
185
186
 
186
187
  **October 2024**
187
- * Exposed ```payload``` property on all objects from [bkper-js](/docs/bkper-js) interface
188
- * Added [Collection.addBooks](/docs/bkper-js/#collection_addbooks)
189
- * Added [Collection.create](/docs/bkper-js/#collection_create)
190
- * Added [Collection.getOwnerUsername](/docs/bkper-js/#collection_getownerusername)
191
- * Added [Collection.getPermission](/docs/bkper-js/#collection_getpermission)
192
- * Added [Collection.getUpdatedAt](/docs/bkper-js/#collection_getupdatedat)
193
- * Added [Collection.remove](/docs/bkper-js/#collection_remove)
194
- * Added [Collection.removeBooks](/docs/bkper-js/#collection_removebooks)
195
- * Added [Collection.setName](/docs/bkper-js/#collection_setname)
196
- * Added [Collection.update](/docs/bkper-js/#collection_update)
197
- * Added [Bkper.getBillingPortalUrl](/docs/bkper-js/#bkper_getbillingportalurl)
198
- * Added [Connection.getDateAddedMs](/docs/bkper-js/#connection_getdateaddedms)
199
- * Added [Connection.getLogo](/docs/bkper-js/#connection_getlogo)
200
- * Added [Connection.remove](/docs/bkper-js/#connection_remove)
201
- * Added [Integration.getAddedBy](/docs/bkper-js/#integration_getaddedby)
202
- * Added [Integration.getAgentId](/docs/bkper-js/#integration_getagentid)
203
- * Added [Integration.getDateAddedMs](/docs/bkper-js/#integration_getdateaddedms)
204
- * Added [Integration.getLastUpdateMs](/docs/bkper-js/#integration_getlastupdatems)
205
- * Added [Integration.getLogo](/docs/bkper-js/#integration_getlogo)
206
- * Added [Integration.remove](/docs/bkper-js/#integration_remove)
207
- * Added [TransactionList](/docs/bkper-js/#transactionlist) returned from [Book.listTransactions](/docs/bkper-js/#book_listtransactions)
208
- * Removed ```TransactionIterator``` from [Transaction](/docs/bkper-js/#transaction)
209
- * Removed ```newTransaction``` from [Book](/docs/bkper-js/#book). Use [Transaction](/docs/bkper-js/#transaction) constructor instead
210
- * Removed ```newAccount``` from [Book](/docs/bkper-js/#book). Use [Account](/docs/bkper-js/#account) constructor instead
211
- * Removed ```newGroup``` from [Book](/docs/bkper-js/#book). Use [Group](/docs/bkper-js/#group) constructor instead
212
- * 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
213
214
 
214
215
  **September 2024**
215
- * Extracted [bkper-js](https://github.com/bkper/bkper-js) from [bkper](https://github.com/bkper/bkper-node) as a standalone library.
216
- * Added [Config.requestRetryHandler](/docs/bkper-js/#config_requestretryhandler)
217
- * Added [Visibility](/docs/bkper-js/#visibility) enum
218
- * Added [App.json](/docs/bkper-js/#app_json)
219
- * Added [Bkper.getApps](/docs/bkper-js/#bkper_getapps)
220
- * Added [Bkper.getBooks](/docs/bkper-js/#bkper_getbooks)
221
- * Added [Bkper.getTemplates](/docs/bkper-js/#bkper_gettemplates)
222
- * Added [Bkper.newBook](/docs/bkper-js/#bkper_newbook)
223
- * Added [Book.getTotalTransactions](/docs/bkper-js/#book_gettotaltransactions)
224
- * Added [Book.getTotalTransactionsCurrentMonth](/docs/bkper-js/#book_gettotaltransactionscurrentmonth)
225
- * Added [Book.getTotalTransactionsCurrentYear](/docs/bkper-js/#book_gettotaltransactionscurrentyear)
226
- * Added [Book.getVisibility](/docs/bkper-js/#book_getvisibility)
227
- * Added [Book.create](/docs/bkper-js/#book_create)
228
- * Added [Collection.json](/docs/bkper-js/#collection_json)
229
- * Added [Template](/docs/bkper-js/#template)
230
- * Added [Template.getBookId](/docs/bkper-js/#template_getbookid)
231
- * Added [Template.getBookLink](/docs/bkper-js/#template_getbooklink)
232
- * Added [Template.getCategory](/docs/bkper-js/#template_getcategory)
233
- * Added [Template.getDescription](/docs/bkper-js/#template_getdescription)
234
- * Added [Template.getImageUrl](/docs/bkper-js/#template_getimageurl)
235
- * Added [Template.getName](/docs/bkper-js/#template_getname)
236
- * Added [Template.getSheetsLink](/docs/bkper-js/#template_getsheetslink)
237
- * Added [Template.getTimesUsed](/docs/bkper-js/#template_gettimesused)
238
- * Added [Template.json](/docs/bkper-js/#template_json)
239
- * Added [User.getEmail](/docs/bkper-js/#user_getemail)
240
- * Added [User.getHostedDomain](/docs/bkper-js/#user_gethosteddomain)
241
- * Added [User.isFree](/docs/bkper-js/#user_isfree)
242
- * Added [User.hasStartedTrial](/docs/bkper-js/#user_hasstartedtrial)
243
- * Added [User.getDaysLeftInTrial](/docs/bkper-js/#user_getdaysleftintrial)
244
- * Added [User.hasUsedConnections](/docs/bkper-js/#user_hasusedconnections)
245
- * 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`
246
247
 
247
248
  **January 2024**
248
- * Added [Transaction.setChecked](/docs/bkper-js/#transaction_setchecked)
249
+ * Added `Transaction.setChecked`
249
250
 
250
251
 
251
252
  2023
252
253
  ----
253
254
 
254
255
  **June 2023**
255
- * Added [Bkper.getUser](/docs/bkper-js/#bkper_getuser)
256
- * Added [Bkper.setConfig](/docs/bkper-js/#bkper_setconfig)
257
- * Added [Book.batchTrashTransactions](/docs/bkper-js/#book_batchtrashtransactions)
258
- * Added [Book.createIntegration](/docs/bkper-js/#book_createintegration)
259
- * Added [Book.getIntegrations](/docs/bkper-js/#book_getintegrations)
260
- * Added [Book.updateIntegration](/docs/bkper-js/#book_updateintegration)
261
- * Added [Config](/docs/bkper-js/#config) interface
262
- * Added [Connection](/docs/bkper-js/#connection)
263
- * Added [Connection.clearTokenProperties](/docs/bkper-js/#connection_cleartokenproperties)
264
- * Added [Connection.create](/docs/bkper-js/#connection_create)
265
- * Added [Connection.deleteProperty](/docs/bkper-js/#connection_deleteproperty)
266
- * Added [Connection.getAgentId](/docs/bkper-js/#connection_getagentid)
267
- * Added [Connection.getEmail](/docs/bkper-js/#connection_getemail)
268
- * Added [Connection.getId](/docs/bkper-js/#connection_getid)
269
- * Added [Connection.getIntegrations](/docs/bkper-js/#connection_getintegrations)
270
- * Added [Connection.getName](/docs/bkper-js/#connection_getname)
271
- * Added [Connection.getProperties](/docs/bkper-js/#connection_getproperties)
272
- * Added [Connection.getProperty](/docs/bkper-js/#connection_getproperty)
273
- * Added [Connection.getPropertyKeys](/docs/bkper-js/#connection_getpropertykeys)
274
- * Added [Connection.getType](/docs/bkper-js/#connection_gettype)
275
- * Added [Connection.getUUID](/docs/bkper-js/#connection_getuuid)
276
- * Added [Connection.json](/docs/bkper-js/#connection_json)
277
- * Added [Connection.setAgentId](/docs/bkper-js/#connection_setagentid)
278
- * Added [Connection.setName](/docs/bkper-js/#connection_setname)
279
- * Added [Connection.setProperties](/docs/bkper-js/#connection_setproperties)
280
- * Added [Connection.setProperty](/docs/bkper-js/#connection_setproperty)
281
- * Added [Connection.setType](/docs/bkper-js/#connection_settype)
282
- * Added [Connection.setUUID](/docs/bkper-js/#connection_setuuid)
283
- * Added [Integration](/docs/bkper-js/#integration)
284
- * Added [Integration.deleteProperty](/docs/bkper-js/#integration_deleteproperty)
285
- * Added [Integration.getBookId](/docs/bkper-js/#integration_getbookid)
286
- * Added [Integration.getId](/docs/bkper-js/#integration_getid)
287
- * Added [Integration.getName](/docs/bkper-js/#integration_getname)
288
- * Added [Integration.getProperties](/docs/bkper-js/#integration_getproperties)
289
- * Added [Integration.getProperty](/docs/bkper-js/#integration_getproperty)
290
- * Added [Integration.json](/docs/bkper-js/#integration_json)
291
- * Added [Integration.setProperties](/docs/bkper-js/#integration_setproperties)
292
- * Added [Integration.setProperty](/docs/bkper-js/#integration_setproperty)
293
- * Added [User](/docs/bkper-js/#user)
294
- * Added [User.getConnection](/docs/bkper-js/#user_getconnection)
295
- * Added [User.getConnections](/docs/bkper-js/#user_getconnections)
296
- * Added [User.getFullName](/docs/bkper-js/#user_getfullname)
297
- * Added [User.getId](/docs/bkper-js/#user_getid)
298
- * Added [User.getName](/docs/bkper-js/#user_getname)
299
- * Deprecated [Bkper.setApiKey](/docs/bkper-js/#bkper_setapikey)
300
- * 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`
301
302
 
302
303
 
303
304
  2022
304
305
  ----
305
306
 
306
307
  **September 2022**
307
- * Deprecated [Account.getBalance](/docs/bkper-js/#account_getbalance)
308
+ * Deprecated `Account.getBalance`
308
309
 
309
310
  **May 2022**
310
- * Added [Book.parseDate](/docs/bkper-js/#book_parsedate)
311
+ * Added `Book.parseDate`
311
312
 
312
313
  **April 2022**
313
- * Added [Book.getClosingDate](/docs/bkper-js/#book_getclosingdate)
314
- * Added [Book.setClosingDate](/docs/bkper-js/#book_setclosingdate)
314
+ * Added `Book.getClosingDate`
315
+ * Added `Book.setClosingDate`
315
316
 
316
317
 
317
318
  2021
318
319
  ----
319
320
 
320
321
  **October 2021**
321
- * Added [Book.getGroupsByAccount](/docs/bkper-js/#book_getgroupsbyaccount)
322
+ * Added `Book.getGroupsByAccount`
322
323
 
323
324
  **May 2021**
324
- * Added [Group.getParent](/docs/bkper-js/#group_getparent)
325
- * Added [Group.setParent](/docs/bkper-js/#group_setparent)
326
- * **BREAKING CHANGE:** Removed **AccountsDataTableBuilder**
327
- * **BREAKING CHANGE:** Removed **BalancesDataTableBuilder**
328
- * **BREAKING CHANGE:** Removed **TransactionsDataTableBuilder**
329
- * **BREAKING CHANGE:** Removed **BalancesReport**
330
- * **BREAKING CHANGE:** Removed **Balance**
331
- * **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`
332
333
 
333
334
  **April 2021**
334
- * Added [Book.getLockDate](/docs/bkper-js/#book_getlockdate)
335
- * Added [Book.setLockDate](/docs/bkper-js/#book_setlockdate)
335
+ * Added `Book.getLockDate`
336
+ * Added `Book.setLockDate`
336
337
 
337
338
  **March 2021**
338
- * **BREAKING CHANGE:** : Removed **BalanceCheckedType**
339
+ * **BREAKING CHANGE:** Removed `BalanceCheckedType`
339
340
 
340
341
  **February 2021**
341
- * Added [Book.getPeriod](/docs/bkper-js/#book_getperiod)
342
- * Added [Book.setPeriod](/docs/bkper-js/#book_setperiod)
343
- * Added [Book.getPeriodStartMonth](/docs/bkper-js/#book_getperiodstartmonth)
344
- * Added [Book.setPeriodStartMonth](/docs/bkper-js/#book_setperiodstartmonth)
345
- * Added [Book.getPageSize](/docs/bkper-js/#book_getpagesize)
346
- * 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`
347
348
 
348
349
  **January 2021**
349
- * [bkper](https://www.npmjs.com/package/bkper) client library published
350
+ * `bkper` client library published
package/lib/index.d.ts CHANGED
@@ -890,7 +890,7 @@ export declare interface BalancesContainer {
890
890
  *
891
891
  * Gets the property value for given keys. First property found will be retrieved
892
892
  *
893
- * @param keys The property key
893
+ * @param keys - The property key
894
894
  */
895
895
  getProperty(...keys: string[]): string | undefined;
896
896
  /**
@@ -968,7 +968,7 @@ declare class BalancesDataTableBuilder implements BalancesDataTableBuilder {
968
968
  /**
969
969
  * Fluent method to set the [[BalanceType]] for the builder.
970
970
  *
971
- * @param type The type of balance for this data table
971
+ * @param type - The type of balance for this data table
972
972
  *
973
973
  * For **TOTAL** [[BalanceType]], the table format looks like:
974
974
  *
@@ -1368,6 +1368,8 @@ export declare class Book {
1368
1368
  /**
1369
1369
  * Sets the date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
1370
1370
  *
1371
+ * @param datePattern - The date pattern to set
1372
+ *
1371
1373
  * @returns This Book, for chaining
1372
1374
  */
1373
1375
  setDatePattern(datePattern: string): Book;
@@ -1380,6 +1382,8 @@ export declare class Book {
1380
1382
  /**
1381
1383
  * Sets the lock date of the Book in ISO format yyyy-MM-dd.
1382
1384
  *
1385
+ * @param lockDate - The lock date to set in ISO format yyyy-MM-dd
1386
+ *
1383
1387
  * @returns This Book, for chaining
1384
1388
  */
1385
1389
  setLockDate(lockDate: string | null): Book;
@@ -1392,6 +1396,8 @@ export declare class Book {
1392
1396
  /**
1393
1397
  * Sets the closing date of the Book in ISO format yyyy-MM-dd.
1394
1398
  *
1399
+ * @param closingDate - The closing date to set in ISO format yyyy-MM-dd
1400
+ *
1395
1401
  * @returns This Book, for chaining
1396
1402
  */
1397
1403
  setClosingDate(closingDate: string | null): Book;
@@ -1404,6 +1410,8 @@ export declare class Book {
1404
1410
  /**
1405
1411
  * Sets the decimal separator of the Book
1406
1412
  *
1413
+ * @param decimalSeparator - The decimal separator to set
1414
+ *
1407
1415
  * @returns This Book, for chaining
1408
1416
  */
1409
1417
  setDecimalSeparator(decimalSeparator: DecimalSeparator): Book;
@@ -1416,6 +1424,8 @@ export declare class Book {
1416
1424
  /**
1417
1425
  * Sets the time zone of the Book.
1418
1426
  *
1427
+ * @param timeZone - The time zone to set
1428
+ *
1419
1429
  * @returns This Book, for chaining
1420
1430
  */
1421
1431
  setTimeZone(timeZone: string): Book;
@@ -1434,6 +1444,8 @@ export declare class Book {
1434
1444
  /**
1435
1445
  * Sets the auto post status of the Book.
1436
1446
  *
1447
+ * @param autoPost - The auto post status to set
1448
+ *
1437
1449
  * @returns This Book, for chaining
1438
1450
  */
1439
1451
  setAutoPost(autoPost: boolean): Book;
@@ -2507,6 +2519,8 @@ export declare class Group {
2507
2519
  /**
2508
2520
  * Sets the name of the Group.
2509
2521
  *
2522
+ * @param name - The name to set
2523
+ *
2510
2524
  * @returns This Group, for chaining
2511
2525
  */
2512
2526
  setName(name: string): Group;
@@ -1,5 +1,5 @@
1
1
  import * as Utils from '../utils.js';
2
- import { Amount } from "./Amount";
2
+ import { Amount } from "./Amount.js";
3
3
  /**
4
4
  * Class that represents an [[Account]] or [[Group]] balance on a window of time (Day / Month / Year).
5
5
  *
@@ -1,5 +1,5 @@
1
- import { Amount } from "./Amount";
2
- import { BalanceType } from "./Enums";
1
+ import { Amount } from "./Amount.js";
2
+ import { BalanceType } from "./Enums.js";
3
3
  import * as Utils from '../utils.js';
4
4
  /**
5
5
  * A BalancesDataTableBuilder is used to setup and build two-dimensional arrays containing balance information.
@@ -84,7 +84,7 @@ export class BalancesDataTableBuilder {
84
84
  /**
85
85
  * Fluent method to set the [[BalanceType]] for the builder.
86
86
  *
87
- * @param type The type of balance for this data table
87
+ * @param type - The type of balance for this data table
88
88
  *
89
89
  * For **TOTAL** [[BalanceType]], the table format looks like:
90
90
  *
package/lib/model/Book.js CHANGED
@@ -203,6 +203,8 @@ export class Book {
203
203
  /**
204
204
  * Sets the date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
205
205
  *
206
+ * @param datePattern - The date pattern to set
207
+ *
206
208
  * @returns This Book, for chaining
207
209
  */
208
210
  setDatePattern(datePattern) {
@@ -220,6 +222,8 @@ export class Book {
220
222
  /**
221
223
  * Sets the lock date of the Book in ISO format yyyy-MM-dd.
222
224
  *
225
+ * @param lockDate - The lock date to set in ISO format yyyy-MM-dd
226
+ *
223
227
  * @returns This Book, for chaining
224
228
  */
225
229
  setLockDate(lockDate) {
@@ -240,6 +244,8 @@ export class Book {
240
244
  /**
241
245
  * Sets the closing date of the Book in ISO format yyyy-MM-dd.
242
246
  *
247
+ * @param closingDate - The closing date to set in ISO format yyyy-MM-dd
248
+ *
243
249
  * @returns This Book, for chaining
244
250
  */
245
251
  setClosingDate(closingDate) {
@@ -260,6 +266,8 @@ export class Book {
260
266
  /**
261
267
  * Sets the decimal separator of the Book
262
268
  *
269
+ * @param decimalSeparator - The decimal separator to set
270
+ *
263
271
  * @returns This Book, for chaining
264
272
  */
265
273
  setDecimalSeparator(decimalSeparator) {
@@ -277,6 +285,8 @@ export class Book {
277
285
  /**
278
286
  * Sets the time zone of the Book.
279
287
  *
288
+ * @param timeZone - The time zone to set
289
+ *
280
290
  * @returns This Book, for chaining
281
291
  */
282
292
  setTimeZone(timeZone) {
@@ -302,6 +312,8 @@ export class Book {
302
312
  /**
303
313
  * Sets the auto post status of the Book.
304
314
  *
315
+ * @param autoPost - The auto post status to set
316
+ *
305
317
  * @returns This Book, for chaining
306
318
  */
307
319
  setAutoPost(autoPost) {
@@ -55,6 +55,8 @@ export class Group {
55
55
  /**
56
56
  * Sets the name of the Group.
57
57
  *
58
+ * @param name - The name to set
59
+ *
58
60
  * @returns This Group, for chaining
59
61
  */
60
62
  setName(name) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "bkper-js",
3
- "version": "2.2.0",
3
+ "version": "2.2.2",
4
4
  "description": "Javascript client for Bkper REST API",
5
5
  "main": "./lib/index.js",
6
6
  "module": "./lib/index.js",