@bkper/bkper-api-types 5.36.0 → 5.38.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.claude/settings.local.json +9 -0
- package/CLAUDE.md +1 -1
- package/README.md +12 -5
- package/index.d.ts +137 -111
- package/package.json +2 -2
package/CLAUDE.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
**DO NOT manually edit `index.d.ts`** - this file is auto-generated.
|
|
6
6
|
|
|
7
|
-
The types are generated from the Bkper [Open API spec](https://bkper.com/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
|
|
7
|
+
The types are generated from the Bkper [Open API spec](https://bkper.com/docs/api/rest/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
|
|
8
8
|
|
|
9
9
|
## Regenerating Types
|
|
10
10
|
|
package/README.md
CHANGED
|
@@ -4,19 +4,27 @@ This package contains Typescript definitions for the [Bkper REST API](https://bk
|
|
|
4
4
|
|
|
5
5
|
[](https://www.npmjs.com/package/@bkper/bkper-api-types)
|
|
6
6
|
|
|
7
|
-
The types are generated based on the Bkper [Open API spec](https://bkper.com/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
|
|
7
|
+
The types are generated based on the Bkper [Open API spec](https://bkper.com/docs/api/rest/openapi.json) using the [dtsgenerator](https://github.com/horiuchi/dtsgenerator) tool.
|
|
8
8
|
|
|
9
9
|
More information at the [Bkper Developer Documentation](http://bkper.com/docs/#rest-api)
|
|
10
10
|
|
|
11
|
-
#
|
|
11
|
+
# Installation
|
|
12
12
|
|
|
13
13
|
### 1) Add the package:
|
|
14
14
|
|
|
15
|
-
```
|
|
15
|
+
```bash tab="npm"
|
|
16
16
|
npm i -S @bkper/bkper-api-types
|
|
17
17
|
```
|
|
18
|
-
|
|
18
|
+
|
|
19
|
+
```bash tab="bun"
|
|
20
|
+
bun add -d @bkper/bkper-api-types
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
```bash tab="pnpm"
|
|
24
|
+
pnpm add -D @bkper/bkper-api-types
|
|
19
25
|
```
|
|
26
|
+
|
|
27
|
+
```bash tab="yarn"
|
|
20
28
|
yarn add --dev @bkper/bkper-api-types
|
|
21
29
|
```
|
|
22
30
|
|
|
@@ -31,4 +39,3 @@ yarn add --dev @bkper/bkper-api-types
|
|
|
31
39
|
```
|
|
32
40
|
|
|
33
41
|
[Learn more](https://www.typescriptlang.org/docs/handbook/tsconfig-json.html#types-typeroots-and-types) about **@types**, **typeRoots** and **types**
|
|
34
|
-
|
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@ declare namespace bkper {
|
|
|
9
9
|
*/
|
|
10
10
|
archived?: boolean;
|
|
11
11
|
/**
|
|
12
|
-
* The current account balance,
|
|
12
|
+
* The running balance of the account at the transaction date. Only present when the account is part of a transaction response filtered by account. NOT the current account balance. To get current balances, use the Balances endpoint: GET /books/{bookId}/balances
|
|
13
13
|
*/
|
|
14
14
|
balance?: string;
|
|
15
15
|
/**
|
|
@@ -29,7 +29,7 @@ declare namespace bkper {
|
|
|
29
29
|
*/
|
|
30
30
|
groups?: Group[];
|
|
31
31
|
/**
|
|
32
|
-
*
|
|
32
|
+
* Whether the account has any transactions posted
|
|
33
33
|
*/
|
|
34
34
|
hasTransactionPosted?: boolean;
|
|
35
35
|
/**
|
|
@@ -105,8 +105,6 @@ declare namespace bkper {
|
|
|
105
105
|
*/
|
|
106
106
|
name?: string;
|
|
107
107
|
}
|
|
108
|
-
export interface Any {
|
|
109
|
-
}
|
|
110
108
|
export interface App {
|
|
111
109
|
/**
|
|
112
110
|
* The API version of the event payload
|
|
@@ -121,11 +119,11 @@ declare namespace bkper {
|
|
|
121
119
|
*/
|
|
122
120
|
clientSecret?: string;
|
|
123
121
|
/**
|
|
124
|
-
*
|
|
122
|
+
* Whether this app is connectable by a user
|
|
125
123
|
*/
|
|
126
124
|
connectable?: boolean;
|
|
127
125
|
/**
|
|
128
|
-
*
|
|
126
|
+
* Whether the app is deprecated
|
|
129
127
|
*/
|
|
130
128
|
deprecated?: boolean;
|
|
131
129
|
/**
|
|
@@ -141,7 +139,7 @@ declare namespace bkper {
|
|
|
141
139
|
*/
|
|
142
140
|
events?: ("FILE_CREATED" | "FILE_UPDATED" | "TRANSACTION_CREATED" | "TRANSACTION_UPDATED" | "TRANSACTION_DELETED" | "TRANSACTION_POSTED" | "TRANSACTION_CHECKED" | "TRANSACTION_UNCHECKED" | "TRANSACTION_RESTORED" | "ACCOUNT_CREATED" | "ACCOUNT_UPDATED" | "ACCOUNT_DELETED" | "QUERY_CREATED" | "QUERY_UPDATED" | "QUERY_DELETED" | "GROUP_CREATED" | "GROUP_UPDATED" | "GROUP_DELETED" | "COMMENT_CREATED" | "COMMENT_DELETED" | "COLLABORATOR_ADDED" | "COLLABORATOR_UPDATED" | "COLLABORATOR_REMOVED" | "INTEGRATION_CREATED" | "INTEGRATION_UPDATED" | "INTEGRATION_DELETED" | "BOOK_CREATED" | "BOOK_AUDITED" | "BOOK_UPDATED" | "BOOK_DELETED")[];
|
|
143
141
|
/**
|
|
144
|
-
* File
|
|
142
|
+
* File patterns the App handles - wildcard accepted. E.g. *.pdf, *-bank.csv
|
|
145
143
|
*/
|
|
146
144
|
filePatterns?: string[];
|
|
147
145
|
/**
|
|
@@ -149,7 +147,7 @@ declare namespace bkper {
|
|
|
149
147
|
*/
|
|
150
148
|
id?: string;
|
|
151
149
|
/**
|
|
152
|
-
*
|
|
150
|
+
* Whether this app is installable in a book
|
|
153
151
|
*/
|
|
154
152
|
installable?: boolean;
|
|
155
153
|
/**
|
|
@@ -206,7 +204,7 @@ declare namespace bkper {
|
|
|
206
204
|
ownerWebsite?: string;
|
|
207
205
|
propertiesSchema?: AppPropertiesSchema;
|
|
208
206
|
/**
|
|
209
|
-
*
|
|
207
|
+
* Whether this app is already published
|
|
210
208
|
*/
|
|
211
209
|
published?: boolean;
|
|
212
210
|
/**
|
|
@@ -218,7 +216,7 @@ declare namespace bkper {
|
|
|
218
216
|
*/
|
|
219
217
|
readmeMd?: string;
|
|
220
218
|
/**
|
|
221
|
-
*
|
|
219
|
+
* Whether the code repository is private
|
|
222
220
|
*/
|
|
223
221
|
repoPrivate?: boolean;
|
|
224
222
|
/**
|
|
@@ -347,7 +345,7 @@ declare namespace bkper {
|
|
|
347
345
|
*/
|
|
348
346
|
autoPost?: boolean;
|
|
349
347
|
/**
|
|
350
|
-
* The book closing date
|
|
348
|
+
* The book closing date, in ISO format yyyy-MM-dd. Transactions on or before this date are closed for the period
|
|
351
349
|
*/
|
|
352
350
|
closingDate?: string;
|
|
353
351
|
collection?: Collection;
|
|
@@ -364,7 +362,7 @@ declare namespace bkper {
|
|
|
364
362
|
*/
|
|
365
363
|
decimalSeparator?: "DOT" | "COMMA";
|
|
366
364
|
/**
|
|
367
|
-
* The number of fraction digits (decimal places) of the Book
|
|
365
|
+
* The number of fraction digits (decimal places) of the Book. E.g. 2 for ####.##, 4 for ####.####
|
|
368
366
|
*/
|
|
369
367
|
fractionDigits?: number; // int32
|
|
370
368
|
/**
|
|
@@ -376,11 +374,11 @@ declare namespace bkper {
|
|
|
376
374
|
*/
|
|
377
375
|
id?: string;
|
|
378
376
|
/**
|
|
379
|
-
* The last update date of the Book, in
|
|
377
|
+
* The last update date of the Book, in milliseconds
|
|
380
378
|
*/
|
|
381
379
|
lastUpdateMs?: string;
|
|
382
380
|
/**
|
|
383
|
-
* The book lock date
|
|
381
|
+
* The book lock date, in ISO format yyyy-MM-dd. Transactions on or before this date are locked
|
|
384
382
|
*/
|
|
385
383
|
lockDate?: string;
|
|
386
384
|
/**
|
|
@@ -414,7 +412,7 @@ declare namespace bkper {
|
|
|
414
412
|
[name: string]: string;
|
|
415
413
|
};
|
|
416
414
|
/**
|
|
417
|
-
* The time zone of the Book
|
|
415
|
+
* The time zone of the Book, in IANA format. E.g. America/New_York, Europe/London
|
|
418
416
|
*/
|
|
419
417
|
timeZone?: string;
|
|
420
418
|
/**
|
|
@@ -511,6 +509,9 @@ declare namespace bkper {
|
|
|
511
509
|
* The username of the Collection owner
|
|
512
510
|
*/
|
|
513
511
|
ownerUsername?: string;
|
|
512
|
+
/**
|
|
513
|
+
* The permission the current user has in the Collection. E.g. OWNER, EDITOR, NONE
|
|
514
|
+
*/
|
|
514
515
|
permission?: "OWNER" | "EDITOR" | "POSTER" | "RECORDER" | "VIEWER" | "NONE";
|
|
515
516
|
/**
|
|
516
517
|
* The last update timestamp, in milliseconds
|
|
@@ -600,7 +601,7 @@ declare namespace bkper {
|
|
|
600
601
|
user?: User;
|
|
601
602
|
}
|
|
602
603
|
export interface EventData {
|
|
603
|
-
object?:
|
|
604
|
+
object?: unknown;
|
|
604
605
|
/**
|
|
605
606
|
* The object previous attributes when updated
|
|
606
607
|
*/
|
|
@@ -672,19 +673,19 @@ declare namespace bkper {
|
|
|
672
673
|
*/
|
|
673
674
|
createdAt?: string;
|
|
674
675
|
/**
|
|
675
|
-
*
|
|
676
|
+
* Whether the group has credit nature
|
|
676
677
|
*/
|
|
677
678
|
credit?: boolean;
|
|
678
679
|
/**
|
|
679
|
-
*
|
|
680
|
+
* Whether the group has any accounts
|
|
680
681
|
*/
|
|
681
682
|
hasAccounts?: boolean;
|
|
682
683
|
/**
|
|
683
|
-
*
|
|
684
|
+
* Whether the group has any children groups
|
|
684
685
|
*/
|
|
685
686
|
hasGroups?: boolean;
|
|
686
687
|
/**
|
|
687
|
-
*
|
|
688
|
+
* Whether the group is hidden on the transactions main menu
|
|
688
689
|
*/
|
|
689
690
|
hidden?: boolean;
|
|
690
691
|
/**
|
|
@@ -692,11 +693,11 @@ declare namespace bkper {
|
|
|
692
693
|
*/
|
|
693
694
|
id?: string;
|
|
694
695
|
/**
|
|
695
|
-
*
|
|
696
|
+
* Whether the group is locked by the Book owner
|
|
696
697
|
*/
|
|
697
698
|
locked?: boolean;
|
|
698
699
|
/**
|
|
699
|
-
*
|
|
700
|
+
* Whether the group has mixed types of accounts
|
|
700
701
|
*/
|
|
701
702
|
mixed?: boolean;
|
|
702
703
|
/**
|
|
@@ -709,7 +710,7 @@ declare namespace bkper {
|
|
|
709
710
|
normalizedName?: string;
|
|
710
711
|
parent?: Group;
|
|
711
712
|
/**
|
|
712
|
-
*
|
|
713
|
+
* Whether the group is permanent
|
|
713
714
|
*/
|
|
714
715
|
permanent?: boolean;
|
|
715
716
|
/**
|
|
@@ -718,6 +719,9 @@ declare namespace bkper {
|
|
|
718
719
|
properties?: {
|
|
719
720
|
[name: string]: string;
|
|
720
721
|
};
|
|
722
|
+
/**
|
|
723
|
+
* The type of the accounts in the group. E.g. ASSET, LIABILITY, INCOMING, OUTGOING
|
|
724
|
+
*/
|
|
721
725
|
type?: "ASSET" | "LIABILITY" | "INCOMING" | "OUTGOING";
|
|
722
726
|
/**
|
|
723
727
|
* The last update timestamp, in milliseconds
|
|
@@ -852,7 +856,7 @@ declare namespace bkper {
|
|
|
852
856
|
*/
|
|
853
857
|
amount?: string;
|
|
854
858
|
/**
|
|
855
|
-
*
|
|
859
|
+
* Whether the transaction is checked
|
|
856
860
|
*/
|
|
857
861
|
checked?: boolean;
|
|
858
862
|
/**
|
|
@@ -882,7 +886,7 @@ declare namespace bkper {
|
|
|
882
886
|
*/
|
|
883
887
|
description?: string;
|
|
884
888
|
/**
|
|
885
|
-
*
|
|
889
|
+
* Whether the transaction is a draft
|
|
886
890
|
*/
|
|
887
891
|
draft?: boolean;
|
|
888
892
|
/**
|
|
@@ -894,7 +898,7 @@ declare namespace bkper {
|
|
|
894
898
|
*/
|
|
895
899
|
id?: string;
|
|
896
900
|
/**
|
|
897
|
-
*
|
|
901
|
+
* Whether the transaction is already posted on accounts, otherwise is a draft
|
|
898
902
|
*/
|
|
899
903
|
posted?: boolean;
|
|
900
904
|
/**
|
|
@@ -912,7 +916,7 @@ declare namespace bkper {
|
|
|
912
916
|
*/
|
|
913
917
|
tags?: string[];
|
|
914
918
|
/**
|
|
915
|
-
*
|
|
919
|
+
* Whether the transaction is trashed
|
|
916
920
|
*/
|
|
917
921
|
trashed?: boolean;
|
|
918
922
|
/**
|
|
@@ -1028,7 +1032,7 @@ declare namespace bkper {
|
|
|
1028
1032
|
}
|
|
1029
1033
|
}
|
|
1030
1034
|
declare namespace Paths {
|
|
1031
|
-
namespace
|
|
1035
|
+
namespace AddBooksToCollection {
|
|
1032
1036
|
export interface BodyParameters {
|
|
1033
1037
|
BookList: Parameters.BookList;
|
|
1034
1038
|
}
|
|
@@ -1039,7 +1043,7 @@ declare namespace Paths {
|
|
|
1039
1043
|
export type $200 = bkper.BookList;
|
|
1040
1044
|
}
|
|
1041
1045
|
}
|
|
1042
|
-
namespace
|
|
1046
|
+
namespace AddCollaborator {
|
|
1043
1047
|
export interface BodyParameters {
|
|
1044
1048
|
Collaborator: Parameters.Collaborator;
|
|
1045
1049
|
}
|
|
@@ -1050,7 +1054,7 @@ declare namespace Paths {
|
|
|
1050
1054
|
export type $200 = bkper.Collaborator;
|
|
1051
1055
|
}
|
|
1052
1056
|
}
|
|
1053
|
-
namespace
|
|
1057
|
+
namespace CheckTransaction {
|
|
1054
1058
|
export interface BodyParameters {
|
|
1055
1059
|
Transaction: Parameters.Transaction;
|
|
1056
1060
|
}
|
|
@@ -1061,7 +1065,7 @@ declare namespace Paths {
|
|
|
1061
1065
|
export type $200 = bkper.TransactionOperation;
|
|
1062
1066
|
}
|
|
1063
1067
|
}
|
|
1064
|
-
namespace
|
|
1068
|
+
namespace CheckTransactionsBatch {
|
|
1065
1069
|
export interface BodyParameters {
|
|
1066
1070
|
TransactionList: Parameters.TransactionList;
|
|
1067
1071
|
}
|
|
@@ -1069,22 +1073,22 @@ declare namespace Paths {
|
|
|
1069
1073
|
export type TransactionList = bkper.TransactionList;
|
|
1070
1074
|
}
|
|
1071
1075
|
}
|
|
1072
|
-
namespace
|
|
1076
|
+
namespace CopyBook {
|
|
1073
1077
|
namespace Responses {
|
|
1074
1078
|
export type $200 = bkper.Book;
|
|
1075
1079
|
}
|
|
1076
1080
|
}
|
|
1077
|
-
namespace
|
|
1081
|
+
namespace CountTransactions {
|
|
1078
1082
|
namespace Responses {
|
|
1079
1083
|
export type $200 = bkper.Count;
|
|
1080
1084
|
}
|
|
1081
1085
|
}
|
|
1082
|
-
namespace
|
|
1086
|
+
namespace CountTransactionsPosted {
|
|
1083
1087
|
namespace Responses {
|
|
1084
1088
|
export type $200 = bkper.Counts;
|
|
1085
1089
|
}
|
|
1086
1090
|
}
|
|
1087
|
-
namespace
|
|
1091
|
+
namespace CreateAccount {
|
|
1088
1092
|
export interface BodyParameters {
|
|
1089
1093
|
Account: Parameters.Account;
|
|
1090
1094
|
}
|
|
@@ -1095,7 +1099,7 @@ declare namespace Paths {
|
|
|
1095
1099
|
export type $200 = bkper.Account;
|
|
1096
1100
|
}
|
|
1097
1101
|
}
|
|
1098
|
-
namespace
|
|
1102
|
+
namespace CreateAccountsBatch {
|
|
1099
1103
|
export interface BodyParameters {
|
|
1100
1104
|
AccountList: Parameters.AccountList;
|
|
1101
1105
|
}
|
|
@@ -1106,7 +1110,7 @@ declare namespace Paths {
|
|
|
1106
1110
|
export type $200 = bkper.AccountList;
|
|
1107
1111
|
}
|
|
1108
1112
|
}
|
|
1109
|
-
namespace
|
|
1113
|
+
namespace CreateApp {
|
|
1110
1114
|
export interface BodyParameters {
|
|
1111
1115
|
App: Parameters.App;
|
|
1112
1116
|
}
|
|
@@ -1117,7 +1121,7 @@ declare namespace Paths {
|
|
|
1117
1121
|
export type $200 = bkper.App;
|
|
1118
1122
|
}
|
|
1119
1123
|
}
|
|
1120
|
-
namespace
|
|
1124
|
+
namespace CreateCollection {
|
|
1121
1125
|
export interface BodyParameters {
|
|
1122
1126
|
Collection: Parameters.Collection;
|
|
1123
1127
|
}
|
|
@@ -1128,7 +1132,7 @@ declare namespace Paths {
|
|
|
1128
1132
|
export type $200 = bkper.Collection;
|
|
1129
1133
|
}
|
|
1130
1134
|
}
|
|
1131
|
-
namespace
|
|
1135
|
+
namespace CreateConnection {
|
|
1132
1136
|
export interface BodyParameters {
|
|
1133
1137
|
Connection: Parameters.Connection;
|
|
1134
1138
|
}
|
|
@@ -1139,7 +1143,7 @@ declare namespace Paths {
|
|
|
1139
1143
|
export type $200 = bkper.Connection;
|
|
1140
1144
|
}
|
|
1141
1145
|
}
|
|
1142
|
-
namespace
|
|
1146
|
+
namespace CreateFile {
|
|
1143
1147
|
export interface BodyParameters {
|
|
1144
1148
|
File: Parameters.File;
|
|
1145
1149
|
}
|
|
@@ -1150,7 +1154,7 @@ declare namespace Paths {
|
|
|
1150
1154
|
export type $200 = bkper.File;
|
|
1151
1155
|
}
|
|
1152
1156
|
}
|
|
1153
|
-
namespace
|
|
1157
|
+
namespace CreateGroup {
|
|
1154
1158
|
export interface BodyParameters {
|
|
1155
1159
|
Group: Parameters.Group;
|
|
1156
1160
|
}
|
|
@@ -1161,7 +1165,7 @@ declare namespace Paths {
|
|
|
1161
1165
|
export type $200 = bkper.Group;
|
|
1162
1166
|
}
|
|
1163
1167
|
}
|
|
1164
|
-
namespace
|
|
1168
|
+
namespace CreateGroupsBatch {
|
|
1165
1169
|
export interface BodyParameters {
|
|
1166
1170
|
GroupList: Parameters.GroupList;
|
|
1167
1171
|
}
|
|
@@ -1172,7 +1176,7 @@ declare namespace Paths {
|
|
|
1172
1176
|
export type $200 = bkper.GroupList;
|
|
1173
1177
|
}
|
|
1174
1178
|
}
|
|
1175
|
-
namespace
|
|
1179
|
+
namespace CreateIntegration {
|
|
1176
1180
|
export interface BodyParameters {
|
|
1177
1181
|
Integration: Parameters.Integration;
|
|
1178
1182
|
}
|
|
@@ -1183,7 +1187,7 @@ declare namespace Paths {
|
|
|
1183
1187
|
export type $200 = bkper.Integration;
|
|
1184
1188
|
}
|
|
1185
1189
|
}
|
|
1186
|
-
namespace
|
|
1190
|
+
namespace CreateNewBook {
|
|
1187
1191
|
export interface BodyParameters {
|
|
1188
1192
|
Book: Parameters.Book;
|
|
1189
1193
|
}
|
|
@@ -1194,7 +1198,7 @@ declare namespace Paths {
|
|
|
1194
1198
|
export type $200 = bkper.Book;
|
|
1195
1199
|
}
|
|
1196
1200
|
}
|
|
1197
|
-
namespace
|
|
1201
|
+
namespace CreateTransaction {
|
|
1198
1202
|
export interface BodyParameters {
|
|
1199
1203
|
Transaction: Parameters.Transaction;
|
|
1200
1204
|
}
|
|
@@ -1205,7 +1209,7 @@ declare namespace Paths {
|
|
|
1205
1209
|
export type $200 = bkper.TransactionOperation;
|
|
1206
1210
|
}
|
|
1207
1211
|
}
|
|
1208
|
-
namespace
|
|
1212
|
+
namespace CreateTransactionsBatch {
|
|
1209
1213
|
export interface BodyParameters {
|
|
1210
1214
|
TransactionList: Parameters.TransactionList;
|
|
1211
1215
|
}
|
|
@@ -1216,197 +1220,208 @@ declare namespace Paths {
|
|
|
1216
1220
|
export type $200 = bkper.TransactionList;
|
|
1217
1221
|
}
|
|
1218
1222
|
}
|
|
1219
|
-
namespace
|
|
1223
|
+
namespace DeleteAccount {
|
|
1220
1224
|
namespace Responses {
|
|
1221
1225
|
export type $200 = bkper.Account;
|
|
1222
1226
|
}
|
|
1223
1227
|
}
|
|
1224
|
-
namespace
|
|
1228
|
+
namespace DeleteAccountsBatch {
|
|
1229
|
+
export interface BodyParameters {
|
|
1230
|
+
AccountList: Parameters.AccountList;
|
|
1231
|
+
}
|
|
1232
|
+
namespace Parameters {
|
|
1233
|
+
export type AccountList = bkper.AccountList;
|
|
1234
|
+
}
|
|
1235
|
+
namespace Responses {
|
|
1236
|
+
export type $200 = bkper.AccountList;
|
|
1237
|
+
}
|
|
1238
|
+
}
|
|
1239
|
+
namespace DeleteBook {
|
|
1225
1240
|
namespace Responses {
|
|
1226
1241
|
export type $200 = bkper.Book;
|
|
1227
1242
|
}
|
|
1228
1243
|
}
|
|
1229
|
-
namespace
|
|
1244
|
+
namespace DeleteCollection {
|
|
1230
1245
|
namespace Responses {
|
|
1231
1246
|
export type $200 = bkper.BookList;
|
|
1232
1247
|
}
|
|
1233
1248
|
}
|
|
1234
|
-
namespace
|
|
1249
|
+
namespace DeleteConnection {
|
|
1235
1250
|
namespace Responses {
|
|
1236
1251
|
export type $200 = bkper.Connection;
|
|
1237
1252
|
}
|
|
1238
1253
|
}
|
|
1239
|
-
namespace
|
|
1254
|
+
namespace DeleteEventResponse {
|
|
1240
1255
|
namespace Responses {
|
|
1241
1256
|
export type $200 = bkper.Event;
|
|
1242
1257
|
}
|
|
1243
1258
|
}
|
|
1244
|
-
namespace
|
|
1259
|
+
namespace DeleteGroup {
|
|
1245
1260
|
namespace Responses {
|
|
1246
1261
|
export type $200 = bkper.Group;
|
|
1247
1262
|
}
|
|
1248
1263
|
}
|
|
1249
|
-
namespace
|
|
1264
|
+
namespace DeleteIntegration {
|
|
1250
1265
|
namespace Responses {
|
|
1251
1266
|
export type $200 = bkper.Integration;
|
|
1252
1267
|
}
|
|
1253
1268
|
}
|
|
1254
|
-
namespace
|
|
1269
|
+
namespace DeleteQuery {
|
|
1255
1270
|
namespace Responses {
|
|
1256
1271
|
export type $200 = bkper.Query;
|
|
1257
1272
|
}
|
|
1258
1273
|
}
|
|
1259
|
-
namespace
|
|
1274
|
+
namespace GetAccount {
|
|
1260
1275
|
namespace Responses {
|
|
1261
1276
|
export type $200 = bkper.Account;
|
|
1262
1277
|
}
|
|
1263
1278
|
}
|
|
1264
|
-
namespace
|
|
1279
|
+
namespace GetApp {
|
|
1265
1280
|
namespace Responses {
|
|
1266
1281
|
export type $200 = bkper.App;
|
|
1267
1282
|
}
|
|
1268
1283
|
}
|
|
1269
|
-
namespace
|
|
1284
|
+
namespace GetBalances {
|
|
1270
1285
|
namespace Responses {
|
|
1271
1286
|
export type $200 = bkper.Balances;
|
|
1272
1287
|
}
|
|
1273
1288
|
}
|
|
1274
|
-
namespace
|
|
1289
|
+
namespace GetBilling {
|
|
1275
1290
|
namespace Responses {
|
|
1276
1291
|
export type $200 = bkper.Billing;
|
|
1277
1292
|
}
|
|
1278
1293
|
}
|
|
1279
|
-
namespace
|
|
1294
|
+
namespace GetBillingCheckout {
|
|
1280
1295
|
namespace Responses {
|
|
1281
1296
|
export type $200 = bkper.Url;
|
|
1282
1297
|
}
|
|
1283
1298
|
}
|
|
1284
|
-
namespace
|
|
1299
|
+
namespace GetBillingPortal {
|
|
1285
1300
|
namespace Responses {
|
|
1286
1301
|
export type $200 = bkper.Url;
|
|
1287
1302
|
}
|
|
1288
1303
|
}
|
|
1289
|
-
namespace
|
|
1304
|
+
namespace GetBook {
|
|
1290
1305
|
namespace Responses {
|
|
1291
1306
|
export type $200 = bkper.Book;
|
|
1292
1307
|
}
|
|
1293
1308
|
}
|
|
1294
|
-
namespace
|
|
1309
|
+
namespace GetBookEventsBacklog {
|
|
1295
1310
|
namespace Responses {
|
|
1296
1311
|
export type $200 = bkper.Backlog;
|
|
1297
1312
|
}
|
|
1298
1313
|
}
|
|
1299
|
-
namespace
|
|
1314
|
+
namespace GetConnection {
|
|
1300
1315
|
namespace Responses {
|
|
1301
1316
|
export type $200 = bkper.Connection;
|
|
1302
1317
|
}
|
|
1303
1318
|
}
|
|
1304
|
-
namespace
|
|
1319
|
+
namespace GetFile {
|
|
1305
1320
|
namespace Responses {
|
|
1306
1321
|
export type $200 = bkper.File;
|
|
1307
1322
|
}
|
|
1308
1323
|
}
|
|
1309
|
-
namespace
|
|
1324
|
+
namespace GetGroup {
|
|
1310
1325
|
namespace Responses {
|
|
1311
1326
|
export type $200 = bkper.Group;
|
|
1312
1327
|
}
|
|
1313
1328
|
}
|
|
1314
|
-
namespace
|
|
1329
|
+
namespace GetTransaction {
|
|
1315
1330
|
namespace Responses {
|
|
1316
1331
|
export type $200 = bkper.Transaction;
|
|
1317
1332
|
}
|
|
1318
1333
|
}
|
|
1319
|
-
namespace
|
|
1334
|
+
namespace GetUser {
|
|
1320
1335
|
namespace Responses {
|
|
1321
1336
|
export type $200 = bkper.User;
|
|
1322
1337
|
}
|
|
1323
1338
|
}
|
|
1324
|
-
namespace
|
|
1339
|
+
namespace ListAccountGroups {
|
|
1325
1340
|
namespace Responses {
|
|
1326
1341
|
export type $200 = bkper.GroupList;
|
|
1327
1342
|
}
|
|
1328
1343
|
}
|
|
1329
|
-
namespace
|
|
1344
|
+
namespace ListAccounts {
|
|
1330
1345
|
namespace Responses {
|
|
1331
1346
|
export type $200 = bkper.AccountList;
|
|
1332
1347
|
}
|
|
1333
1348
|
}
|
|
1334
|
-
namespace
|
|
1349
|
+
namespace ListApps {
|
|
1335
1350
|
namespace Responses {
|
|
1336
1351
|
export type $200 = bkper.AppList;
|
|
1337
1352
|
}
|
|
1338
1353
|
}
|
|
1339
|
-
namespace
|
|
1354
|
+
namespace ListBillingCounts {
|
|
1340
1355
|
namespace Responses {
|
|
1341
1356
|
export type $200 = bkper.Counts;
|
|
1342
1357
|
}
|
|
1343
1358
|
}
|
|
1344
|
-
namespace
|
|
1359
|
+
namespace ListBookApps {
|
|
1345
1360
|
namespace Responses {
|
|
1346
1361
|
export type $200 = bkper.AppList;
|
|
1347
1362
|
}
|
|
1348
1363
|
}
|
|
1349
|
-
namespace
|
|
1364
|
+
namespace ListBooks {
|
|
1350
1365
|
namespace Responses {
|
|
1351
1366
|
export type $200 = bkper.BookList;
|
|
1352
1367
|
}
|
|
1353
1368
|
}
|
|
1354
|
-
namespace
|
|
1369
|
+
namespace ListCollaborators {
|
|
1355
1370
|
namespace Responses {
|
|
1356
1371
|
export type $200 = /* An ordered list of Collaborator */ bkper.CollaboratorPayloadCollection;
|
|
1357
1372
|
}
|
|
1358
1373
|
}
|
|
1359
|
-
namespace
|
|
1374
|
+
namespace ListCollections {
|
|
1360
1375
|
namespace Responses {
|
|
1361
1376
|
export type $200 = bkper.CollectionList;
|
|
1362
1377
|
}
|
|
1363
1378
|
}
|
|
1364
|
-
namespace
|
|
1379
|
+
namespace ListConnectionIntegrations {
|
|
1365
1380
|
namespace Responses {
|
|
1366
1381
|
export type $200 = bkper.IntegrationList;
|
|
1367
1382
|
}
|
|
1368
1383
|
}
|
|
1369
|
-
namespace
|
|
1384
|
+
namespace ListConnections {
|
|
1370
1385
|
namespace Responses {
|
|
1371
1386
|
export type $200 = bkper.ConnectionList;
|
|
1372
1387
|
}
|
|
1373
1388
|
}
|
|
1374
|
-
namespace
|
|
1389
|
+
namespace ListEvents {
|
|
1375
1390
|
namespace Responses {
|
|
1376
1391
|
export type $200 = bkper.EventList;
|
|
1377
1392
|
}
|
|
1378
1393
|
}
|
|
1379
|
-
namespace
|
|
1394
|
+
namespace ListGroupAccounts {
|
|
1380
1395
|
namespace Responses {
|
|
1381
1396
|
export type $200 = bkper.AccountList;
|
|
1382
1397
|
}
|
|
1383
1398
|
}
|
|
1384
|
-
namespace
|
|
1399
|
+
namespace ListGroups {
|
|
1385
1400
|
namespace Responses {
|
|
1386
1401
|
export type $200 = bkper.GroupList;
|
|
1387
1402
|
}
|
|
1388
1403
|
}
|
|
1389
|
-
namespace
|
|
1404
|
+
namespace ListIntegrations {
|
|
1390
1405
|
namespace Responses {
|
|
1391
1406
|
export type $200 = bkper.IntegrationList;
|
|
1392
1407
|
}
|
|
1393
1408
|
}
|
|
1394
|
-
namespace
|
|
1409
|
+
namespace ListQueries {
|
|
1395
1410
|
namespace Responses {
|
|
1396
1411
|
export type $200 = bkper.QueryList;
|
|
1397
1412
|
}
|
|
1398
1413
|
}
|
|
1399
|
-
namespace
|
|
1414
|
+
namespace ListTemplates {
|
|
1400
1415
|
namespace Responses {
|
|
1401
1416
|
export type $200 = bkper.TemplateList;
|
|
1402
1417
|
}
|
|
1403
1418
|
}
|
|
1404
|
-
namespace
|
|
1419
|
+
namespace ListTransactions {
|
|
1405
1420
|
namespace Responses {
|
|
1406
1421
|
export type $200 = bkper.TransactionList;
|
|
1407
1422
|
}
|
|
1408
1423
|
}
|
|
1409
|
-
namespace
|
|
1424
|
+
namespace PostTransaction {
|
|
1410
1425
|
export interface BodyParameters {
|
|
1411
1426
|
Transaction: Parameters.Transaction;
|
|
1412
1427
|
}
|
|
@@ -1417,7 +1432,7 @@ declare namespace Paths {
|
|
|
1417
1432
|
export type $200 = bkper.TransactionOperation;
|
|
1418
1433
|
}
|
|
1419
1434
|
}
|
|
1420
|
-
namespace
|
|
1435
|
+
namespace PostTransactionsBatch {
|
|
1421
1436
|
export interface BodyParameters {
|
|
1422
1437
|
TransactionList: Parameters.TransactionList;
|
|
1423
1438
|
}
|
|
@@ -1425,7 +1440,7 @@ declare namespace Paths {
|
|
|
1425
1440
|
export type TransactionList = bkper.TransactionList;
|
|
1426
1441
|
}
|
|
1427
1442
|
}
|
|
1428
|
-
namespace
|
|
1443
|
+
namespace RemoveBooksFromCollection {
|
|
1429
1444
|
export interface BodyParameters {
|
|
1430
1445
|
BookList: Parameters.BookList;
|
|
1431
1446
|
}
|
|
@@ -1436,12 +1451,12 @@ declare namespace Paths {
|
|
|
1436
1451
|
export type $200 = bkper.BookList;
|
|
1437
1452
|
}
|
|
1438
1453
|
}
|
|
1439
|
-
namespace
|
|
1454
|
+
namespace RemoveCollaborator {
|
|
1440
1455
|
namespace Responses {
|
|
1441
1456
|
export type $200 = bkper.Collaborator;
|
|
1442
1457
|
}
|
|
1443
1458
|
}
|
|
1444
|
-
namespace
|
|
1459
|
+
namespace RemoveTransaction {
|
|
1445
1460
|
export interface BodyParameters {
|
|
1446
1461
|
Transaction: Parameters.Transaction;
|
|
1447
1462
|
}
|
|
@@ -1452,12 +1467,12 @@ declare namespace Paths {
|
|
|
1452
1467
|
export type $200 = bkper.TransactionOperation;
|
|
1453
1468
|
}
|
|
1454
1469
|
}
|
|
1455
|
-
namespace
|
|
1470
|
+
namespace ReplayEventResponse {
|
|
1456
1471
|
namespace Responses {
|
|
1457
1472
|
export type $200 = bkper.Event;
|
|
1458
1473
|
}
|
|
1459
1474
|
}
|
|
1460
|
-
namespace
|
|
1475
|
+
namespace ReplayEvents {
|
|
1461
1476
|
export interface BodyParameters {
|
|
1462
1477
|
EventList: Parameters.EventList;
|
|
1463
1478
|
}
|
|
@@ -1465,7 +1480,7 @@ declare namespace Paths {
|
|
|
1465
1480
|
export type EventList = bkper.EventList;
|
|
1466
1481
|
}
|
|
1467
1482
|
}
|
|
1468
|
-
namespace
|
|
1483
|
+
namespace RestoreTransaction {
|
|
1469
1484
|
export interface BodyParameters {
|
|
1470
1485
|
Transaction: Parameters.Transaction;
|
|
1471
1486
|
}
|
|
@@ -1476,7 +1491,7 @@ declare namespace Paths {
|
|
|
1476
1491
|
export type $200 = bkper.TransactionOperation;
|
|
1477
1492
|
}
|
|
1478
1493
|
}
|
|
1479
|
-
namespace
|
|
1494
|
+
namespace SaveQuery {
|
|
1480
1495
|
export interface BodyParameters {
|
|
1481
1496
|
Query: Parameters.Query;
|
|
1482
1497
|
}
|
|
@@ -1487,7 +1502,7 @@ declare namespace Paths {
|
|
|
1487
1502
|
export type $200 = bkper.Query;
|
|
1488
1503
|
}
|
|
1489
1504
|
}
|
|
1490
|
-
namespace
|
|
1505
|
+
namespace TrashTransaction {
|
|
1491
1506
|
export interface BodyParameters {
|
|
1492
1507
|
Transaction: Parameters.Transaction;
|
|
1493
1508
|
}
|
|
@@ -1498,7 +1513,7 @@ declare namespace Paths {
|
|
|
1498
1513
|
export type $200 = bkper.TransactionOperation;
|
|
1499
1514
|
}
|
|
1500
1515
|
}
|
|
1501
|
-
namespace
|
|
1516
|
+
namespace TrashTransactionsBatch {
|
|
1502
1517
|
export interface BodyParameters {
|
|
1503
1518
|
TransactionList: Parameters.TransactionList;
|
|
1504
1519
|
}
|
|
@@ -1506,7 +1521,7 @@ declare namespace Paths {
|
|
|
1506
1521
|
export type TransactionList = bkper.TransactionList;
|
|
1507
1522
|
}
|
|
1508
1523
|
}
|
|
1509
|
-
namespace
|
|
1524
|
+
namespace UncheckTransaction {
|
|
1510
1525
|
export interface BodyParameters {
|
|
1511
1526
|
Transaction: Parameters.Transaction;
|
|
1512
1527
|
}
|
|
@@ -1517,7 +1532,7 @@ declare namespace Paths {
|
|
|
1517
1532
|
export type $200 = bkper.TransactionOperation;
|
|
1518
1533
|
}
|
|
1519
1534
|
}
|
|
1520
|
-
namespace
|
|
1535
|
+
namespace UncheckTransactionsBatch {
|
|
1521
1536
|
export interface BodyParameters {
|
|
1522
1537
|
TransactionList: Parameters.TransactionList;
|
|
1523
1538
|
}
|
|
@@ -1525,7 +1540,7 @@ declare namespace Paths {
|
|
|
1525
1540
|
export type TransactionList = bkper.TransactionList;
|
|
1526
1541
|
}
|
|
1527
1542
|
}
|
|
1528
|
-
namespace
|
|
1543
|
+
namespace UntrashTransaction {
|
|
1529
1544
|
export interface BodyParameters {
|
|
1530
1545
|
Transaction: Parameters.Transaction;
|
|
1531
1546
|
}
|
|
@@ -1536,7 +1551,7 @@ declare namespace Paths {
|
|
|
1536
1551
|
export type $200 = bkper.TransactionOperation;
|
|
1537
1552
|
}
|
|
1538
1553
|
}
|
|
1539
|
-
namespace
|
|
1554
|
+
namespace UntrashTransactionsBatch {
|
|
1540
1555
|
export interface BodyParameters {
|
|
1541
1556
|
TransactionList: Parameters.TransactionList;
|
|
1542
1557
|
}
|
|
@@ -1544,7 +1559,7 @@ declare namespace Paths {
|
|
|
1544
1559
|
export type TransactionList = bkper.TransactionList;
|
|
1545
1560
|
}
|
|
1546
1561
|
}
|
|
1547
|
-
namespace
|
|
1562
|
+
namespace UpdateAccount {
|
|
1548
1563
|
export interface BodyParameters {
|
|
1549
1564
|
Account: Parameters.Account;
|
|
1550
1565
|
}
|
|
@@ -1555,7 +1570,18 @@ declare namespace Paths {
|
|
|
1555
1570
|
export type $200 = bkper.Account;
|
|
1556
1571
|
}
|
|
1557
1572
|
}
|
|
1558
|
-
namespace
|
|
1573
|
+
namespace UpdateAccountsBatch {
|
|
1574
|
+
export interface BodyParameters {
|
|
1575
|
+
AccountList: Parameters.AccountList;
|
|
1576
|
+
}
|
|
1577
|
+
namespace Parameters {
|
|
1578
|
+
export type AccountList = bkper.AccountList;
|
|
1579
|
+
}
|
|
1580
|
+
namespace Responses {
|
|
1581
|
+
export type $200 = bkper.AccountList;
|
|
1582
|
+
}
|
|
1583
|
+
}
|
|
1584
|
+
namespace UpdateApp {
|
|
1559
1585
|
export interface BodyParameters {
|
|
1560
1586
|
App: Parameters.App;
|
|
1561
1587
|
}
|
|
@@ -1566,7 +1592,7 @@ declare namespace Paths {
|
|
|
1566
1592
|
export type $200 = bkper.App;
|
|
1567
1593
|
}
|
|
1568
1594
|
}
|
|
1569
|
-
namespace
|
|
1595
|
+
namespace UpdateBook {
|
|
1570
1596
|
export interface BodyParameters {
|
|
1571
1597
|
Book: Parameters.Book;
|
|
1572
1598
|
}
|
|
@@ -1577,7 +1603,7 @@ declare namespace Paths {
|
|
|
1577
1603
|
export type $200 = bkper.Book;
|
|
1578
1604
|
}
|
|
1579
1605
|
}
|
|
1580
|
-
namespace
|
|
1606
|
+
namespace UpdateBookDeprecated {
|
|
1581
1607
|
export interface BodyParameters {
|
|
1582
1608
|
Book: Parameters.Book;
|
|
1583
1609
|
}
|
|
@@ -1588,7 +1614,7 @@ declare namespace Paths {
|
|
|
1588
1614
|
export type $200 = bkper.Book;
|
|
1589
1615
|
}
|
|
1590
1616
|
}
|
|
1591
|
-
namespace
|
|
1617
|
+
namespace UpdateCollection {
|
|
1592
1618
|
export interface BodyParameters {
|
|
1593
1619
|
Collection: Parameters.Collection;
|
|
1594
1620
|
}
|
|
@@ -1599,7 +1625,7 @@ declare namespace Paths {
|
|
|
1599
1625
|
export type $200 = bkper.Collection;
|
|
1600
1626
|
}
|
|
1601
1627
|
}
|
|
1602
|
-
namespace
|
|
1628
|
+
namespace UpdateConnection {
|
|
1603
1629
|
export interface BodyParameters {
|
|
1604
1630
|
Connection: Parameters.Connection;
|
|
1605
1631
|
}
|
|
@@ -1610,7 +1636,7 @@ declare namespace Paths {
|
|
|
1610
1636
|
export type $200 = bkper.Connection;
|
|
1611
1637
|
}
|
|
1612
1638
|
}
|
|
1613
|
-
namespace
|
|
1639
|
+
namespace UpdateFile {
|
|
1614
1640
|
export interface BodyParameters {
|
|
1615
1641
|
File: Parameters.File;
|
|
1616
1642
|
}
|
|
@@ -1621,7 +1647,7 @@ declare namespace Paths {
|
|
|
1621
1647
|
export type $200 = bkper.File;
|
|
1622
1648
|
}
|
|
1623
1649
|
}
|
|
1624
|
-
namespace
|
|
1650
|
+
namespace UpdateGroup {
|
|
1625
1651
|
export interface BodyParameters {
|
|
1626
1652
|
Group: Parameters.Group;
|
|
1627
1653
|
}
|
|
@@ -1632,7 +1658,7 @@ declare namespace Paths {
|
|
|
1632
1658
|
export type $200 = bkper.Group;
|
|
1633
1659
|
}
|
|
1634
1660
|
}
|
|
1635
|
-
namespace
|
|
1661
|
+
namespace UpdateIntegration {
|
|
1636
1662
|
export interface BodyParameters {
|
|
1637
1663
|
Integration: Parameters.Integration;
|
|
1638
1664
|
}
|
|
@@ -1643,7 +1669,7 @@ declare namespace Paths {
|
|
|
1643
1669
|
export type $200 = bkper.Integration;
|
|
1644
1670
|
}
|
|
1645
1671
|
}
|
|
1646
|
-
namespace
|
|
1672
|
+
namespace UpdateQuery {
|
|
1647
1673
|
export interface BodyParameters {
|
|
1648
1674
|
Query: Parameters.Query;
|
|
1649
1675
|
}
|
|
@@ -1654,7 +1680,7 @@ declare namespace Paths {
|
|
|
1654
1680
|
export type $200 = bkper.Query;
|
|
1655
1681
|
}
|
|
1656
1682
|
}
|
|
1657
|
-
namespace
|
|
1683
|
+
namespace UpdateTransaction {
|
|
1658
1684
|
export interface BodyParameters {
|
|
1659
1685
|
Transaction: Parameters.Transaction;
|
|
1660
1686
|
}
|
|
@@ -1665,7 +1691,7 @@ declare namespace Paths {
|
|
|
1665
1691
|
export type $200 = bkper.TransactionOperation;
|
|
1666
1692
|
}
|
|
1667
1693
|
}
|
|
1668
|
-
namespace
|
|
1694
|
+
namespace UpdateTransactionsBatch {
|
|
1669
1695
|
export interface BodyParameters {
|
|
1670
1696
|
TransactionList: Parameters.TransactionList;
|
|
1671
1697
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@bkper/bkper-api-types",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.38.0",
|
|
4
4
|
"description": "Typescript definitions for Bkper REST API",
|
|
5
5
|
"homepage": "https://api.bkper.com",
|
|
6
6
|
"repository": {
|
|
@@ -17,7 +17,7 @@
|
|
|
17
17
|
},
|
|
18
18
|
"license": "MIT",
|
|
19
19
|
"scripts": {
|
|
20
|
-
"build": "dtsgen -o index.d.ts --url https://bkper.com/openapi.json",
|
|
20
|
+
"build": "dtsgen -o index.d.ts --url https://bkper.com/docs/api/rest/openapi.json",
|
|
21
21
|
"patch": "yarn version --patch",
|
|
22
22
|
"minor": "yarn version --minor",
|
|
23
23
|
"major": "yarn version --major",
|