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 +280 -279
- package/lib/index.d.ts +16 -2
- package/lib/model/Balance.js +1 -1
- package/lib/model/BalancesDataTableBuilder.js +3 -3
- package/lib/model/Book.js +12 -0
- package/lib/model/Group.js +2 -0
- package/package.json +1 -1
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
|
|
14
|
-
* Added
|
|
15
|
-
* Added
|
|
16
|
-
|
|
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
|
|
20
|
-
* Added
|
|
21
|
-
* Added
|
|
20
|
+
* Added `Book.copy`
|
|
21
|
+
* Added `Transaction.getUpdatedAt`
|
|
22
|
+
* Added `Transaction.getUpdatedAtFormatted`
|
|
22
23
|
|
|
23
24
|
**May 2025**
|
|
24
|
-
* Added
|
|
25
|
-
* Added
|
|
26
|
-
* Added
|
|
27
|
-
* Added
|
|
28
|
-
* Added
|
|
29
|
-
* Added
|
|
30
|
-
* Added
|
|
31
|
-
* Added
|
|
32
|
-
* Added
|
|
33
|
-
* Added
|
|
34
|
-
* Added
|
|
35
|
-
* Added
|
|
36
|
-
* Added
|
|
37
|
-
* Added
|
|
38
|
-
* Added
|
|
39
|
-
* Added
|
|
40
|
-
* Added
|
|
41
|
-
* Added
|
|
42
|
-
* Added
|
|
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
|
|
46
|
-
* Added
|
|
46
|
+
* Added `Book.batchCreateAccounts`
|
|
47
|
+
* Added `Book.batchCreateGroups`
|
|
47
48
|
|
|
48
49
|
**March 2025**
|
|
49
|
-
* Added
|
|
50
|
-
* Added
|
|
51
|
-
* Added
|
|
52
|
-
* Added
|
|
53
|
-
* Added
|
|
54
|
-
* Added
|
|
55
|
-
* Added
|
|
56
|
-
* Added
|
|
57
|
-
* Added
|
|
58
|
-
* Added
|
|
59
|
-
* Added
|
|
60
|
-
* Added
|
|
61
|
-
* Added
|
|
62
|
-
* Added
|
|
63
|
-
* Added
|
|
64
|
-
* Added
|
|
65
|
-
* Added
|
|
66
|
-
* Added
|
|
67
|
-
* Added
|
|
68
|
-
* Added
|
|
69
|
-
* Added
|
|
70
|
-
* Added
|
|
71
|
-
* Added
|
|
72
|
-
* Added
|
|
73
|
-
* Added
|
|
74
|
-
* Added
|
|
75
|
-
* Added
|
|
76
|
-
* Added
|
|
77
|
-
* Added
|
|
78
|
-
* Added
|
|
79
|
-
* Added
|
|
80
|
-
* Added
|
|
81
|
-
* Added
|
|
82
|
-
* Added
|
|
83
|
-
* Added
|
|
84
|
-
* Added
|
|
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
|
|
88
|
-
* Added
|
|
89
|
-
* Added
|
|
90
|
-
* Added
|
|
91
|
-
* Added
|
|
92
|
-
* Added
|
|
93
|
-
* Added
|
|
94
|
-
* Added
|
|
95
|
-
* Added
|
|
96
|
-
* Added
|
|
97
|
-
* Added
|
|
98
|
-
* Added
|
|
99
|
-
* Added
|
|
100
|
-
* Added
|
|
101
|
-
* Added
|
|
102
|
-
* Added
|
|
103
|
-
* Added
|
|
104
|
-
* Added
|
|
105
|
-
* Added
|
|
106
|
-
* Added
|
|
107
|
-
* Added
|
|
108
|
-
* Added
|
|
109
|
-
* Added
|
|
110
|
-
* Added
|
|
111
|
-
* Added
|
|
112
|
-
* Added
|
|
113
|
-
* Added
|
|
114
|
-
* Added
|
|
115
|
-
* Added
|
|
116
|
-
* Added
|
|
117
|
-
* Added
|
|
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
|
|
121
|
-
* Added
|
|
122
|
-
* Added
|
|
123
|
-
* Added
|
|
124
|
-
* Added
|
|
125
|
-
* Added
|
|
126
|
-
* Added
|
|
127
|
-
* Added
|
|
128
|
-
* Added
|
|
129
|
-
* Added
|
|
130
|
-
* Added
|
|
131
|
-
* Added
|
|
132
|
-
* Added
|
|
133
|
-
* Added
|
|
134
|
-
* Added
|
|
135
|
-
* Added
|
|
136
|
-
* Added
|
|
137
|
-
* Added
|
|
138
|
-
* Added
|
|
139
|
-
* Added
|
|
140
|
-
* Added
|
|
141
|
-
* Added
|
|
142
|
-
* Added
|
|
143
|
-
* Added
|
|
144
|
-
* Added
|
|
145
|
-
* Added
|
|
146
|
-
* Added
|
|
147
|
-
* Added
|
|
148
|
-
* Added
|
|
149
|
-
* Added
|
|
150
|
-
* Added
|
|
151
|
-
* Added
|
|
152
|
-
* Added
|
|
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
|
|
160
|
-
* Added
|
|
161
|
-
* Added
|
|
162
|
-
* Added
|
|
163
|
-
* Added
|
|
164
|
-
* Added
|
|
165
|
-
* Added
|
|
166
|
-
* Added
|
|
167
|
-
* Added
|
|
168
|
-
* Added
|
|
169
|
-
* Added
|
|
170
|
-
* Added
|
|
171
|
-
* Added
|
|
172
|
-
* Added
|
|
173
|
-
* Added
|
|
174
|
-
* Added
|
|
175
|
-
* Added
|
|
176
|
-
* Added
|
|
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
|
|
180
|
-
* Added
|
|
181
|
-
* Added
|
|
182
|
-
* Added
|
|
183
|
-
* Removed ```Transaction.remove``` from
|
|
184
|
-
* Removed ```Transaction.restore``` from
|
|
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
|
|
188
|
-
* Added
|
|
189
|
-
* Added
|
|
190
|
-
* Added
|
|
191
|
-
* Added
|
|
192
|
-
* Added
|
|
193
|
-
* Added
|
|
194
|
-
* Added
|
|
195
|
-
* Added
|
|
196
|
-
* Added
|
|
197
|
-
* Added
|
|
198
|
-
* Added
|
|
199
|
-
* Added
|
|
200
|
-
* Added
|
|
201
|
-
* Added
|
|
202
|
-
* Added
|
|
203
|
-
* Added
|
|
204
|
-
* Added
|
|
205
|
-
* Added
|
|
206
|
-
* Added
|
|
207
|
-
* Added
|
|
208
|
-
* Removed ```TransactionIterator``` from
|
|
209
|
-
* Removed ```newTransaction``` from
|
|
210
|
-
* Removed ```newAccount``` from
|
|
211
|
-
* Removed ```newGroup``` from
|
|
212
|
-
* Removed ```newFile``` from
|
|
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
|
|
216
|
-
* Added
|
|
217
|
-
* Added
|
|
218
|
-
* Added
|
|
219
|
-
* Added
|
|
220
|
-
* Added
|
|
221
|
-
* Added
|
|
222
|
-
* Added
|
|
223
|
-
* Added
|
|
224
|
-
* Added
|
|
225
|
-
* Added
|
|
226
|
-
* Added
|
|
227
|
-
* Added
|
|
228
|
-
* Added
|
|
229
|
-
* Added
|
|
230
|
-
* Added
|
|
231
|
-
* Added
|
|
232
|
-
* Added
|
|
233
|
-
* Added
|
|
234
|
-
* Added
|
|
235
|
-
* Added
|
|
236
|
-
* Added
|
|
237
|
-
* Added
|
|
238
|
-
* Added
|
|
239
|
-
* Added
|
|
240
|
-
* Added
|
|
241
|
-
* Added
|
|
242
|
-
* Added
|
|
243
|
-
* Added
|
|
244
|
-
* Added
|
|
245
|
-
* Added
|
|
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
|
|
249
|
+
* Added `Transaction.setChecked`
|
|
249
250
|
|
|
250
251
|
|
|
251
252
|
2023
|
|
252
253
|
----
|
|
253
254
|
|
|
254
255
|
**June 2023**
|
|
255
|
-
* Added
|
|
256
|
-
* Added
|
|
257
|
-
* Added
|
|
258
|
-
* Added
|
|
259
|
-
* Added
|
|
260
|
-
* Added
|
|
261
|
-
* Added
|
|
262
|
-
* Added
|
|
263
|
-
* Added
|
|
264
|
-
* Added
|
|
265
|
-
* Added
|
|
266
|
-
* Added
|
|
267
|
-
* Added
|
|
268
|
-
* Added
|
|
269
|
-
* Added
|
|
270
|
-
* Added
|
|
271
|
-
* Added
|
|
272
|
-
* Added
|
|
273
|
-
* Added
|
|
274
|
-
* Added
|
|
275
|
-
* Added
|
|
276
|
-
* Added
|
|
277
|
-
* Added
|
|
278
|
-
* Added
|
|
279
|
-
* Added
|
|
280
|
-
* Added
|
|
281
|
-
* Added
|
|
282
|
-
* Added
|
|
283
|
-
* Added
|
|
284
|
-
* Added
|
|
285
|
-
* Added
|
|
286
|
-
* Added
|
|
287
|
-
* Added
|
|
288
|
-
* Added
|
|
289
|
-
* Added
|
|
290
|
-
* Added
|
|
291
|
-
* Added
|
|
292
|
-
* Added
|
|
293
|
-
* Added
|
|
294
|
-
* Added
|
|
295
|
-
* Added
|
|
296
|
-
* Added
|
|
297
|
-
* Added
|
|
298
|
-
* Added
|
|
299
|
-
* Deprecated
|
|
300
|
-
* Deprecated
|
|
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
|
|
308
|
+
* Deprecated `Account.getBalance`
|
|
308
309
|
|
|
309
310
|
**May 2022**
|
|
310
|
-
* Added
|
|
311
|
+
* Added `Book.parseDate`
|
|
311
312
|
|
|
312
313
|
**April 2022**
|
|
313
|
-
* Added
|
|
314
|
-
* Added
|
|
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
|
|
322
|
+
* Added `Book.getGroupsByAccount`
|
|
322
323
|
|
|
323
324
|
**May 2021**
|
|
324
|
-
* Added
|
|
325
|
-
* Added
|
|
326
|
-
* **BREAKING CHANGE:** Removed
|
|
327
|
-
* **BREAKING CHANGE:** Removed
|
|
328
|
-
* **BREAKING CHANGE:** Removed
|
|
329
|
-
* **BREAKING CHANGE:** Removed
|
|
330
|
-
* **BREAKING CHANGE:** Removed
|
|
331
|
-
* **BREAKING CHANGE:** Removed
|
|
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
|
|
335
|
-
* Added
|
|
335
|
+
* Added `Book.getLockDate`
|
|
336
|
+
* Added `Book.setLockDate`
|
|
336
337
|
|
|
337
338
|
**March 2021**
|
|
338
|
-
* **BREAKING CHANGE:**
|
|
339
|
+
* **BREAKING CHANGE:** Removed `BalanceCheckedType`
|
|
339
340
|
|
|
340
341
|
**February 2021**
|
|
341
|
-
* Added
|
|
342
|
-
* Added
|
|
343
|
-
* Added
|
|
344
|
-
* Added
|
|
345
|
-
* Added
|
|
346
|
-
* Added
|
|
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
|
-
*
|
|
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;
|
package/lib/model/Balance.js
CHANGED
|
@@ -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) {
|
package/lib/model/Group.js
CHANGED