@bkper/bkper-api-types 5.9.0 → 5.11.0

package/index.d.ts

@@ -58,8 +58,6 @@ declare namespace bkper {
     export interface AccountBalances {
         archived?: boolean;
         balances?: Balance[];
-        checkedCumulativeBalance?: string;
-        checkedPeriodBalance?: string;
         credit?: boolean;
         cumulativeBalance?: string;
         cumulativeCredit?: string;
@@ -74,8 +72,6 @@ declare namespace bkper {
         properties?: {
             [name: string]: string;
         };
-        uncheckedCumulativeBalance?: string;
-        uncheckedPeriodBalance?: string;
     }
     export interface AccountList {
         /**
@@ -116,10 +112,6 @@ declare namespace bkper {
          * Tell if this app is connectable by a user
          */
         connectable?: boolean;
-        /**
-         * The executable Google Apps Script deployment ID
-         */
-        deploymentId?: string;
         /**
          * Tell if the code app is deprecated
          */
@@ -213,10 +205,6 @@ declare namespace bkper {
          * The Google OAuth Scopes used by the app
          */
         scopes?: string[];
-        /**
-         * The executable Google Apps Script ID
-         */
-        scriptId?: string;
         /**
          * The user emails to enable the App while not yet published
          */
@@ -257,8 +245,6 @@ declare namespace bkper {
         count?: number; // int32
     }
     export interface Balance {
-        checkedCumulativeBalance?: string;
-        checkedPeriodBalance?: string;
         cumulativeBalance?: string;
         cumulativeCredit?: string;
         cumulativeDebit?: string;
@@ -268,8 +254,6 @@ declare namespace bkper {
         periodBalance?: string;
         periodCredit?: string;
         periodDebit?: string;
-        uncheckedCumulativeBalance?: string;
-        uncheckedPeriodBalance?: string;
         year?: number; // int32
     }
     export interface Balances {
@@ -378,6 +362,10 @@ declare namespace bkper {
          * The total transactions posted on current year
          */
         totalTransactionsCurrentYear?: number; // int64
+        /**
+         * The Visibility of the Book
+         */
+        visibility?: "PUBLIC" | "PRIVATE";
     }
     export interface BookList {
         /**
@@ -437,6 +425,17 @@ declare namespace bkper {
          * The username of the Collection owner
          */
         ownerUsername?: string;
+        permission?: "OWNER" | "EDITOR" | "POSTER" | "RECORDER" | "VIEWER" | "NONE";
+        /**
+         * The last update timestamp, in milliseconds
+         */
+        updatedAt?: string;
+    }
+    export interface CollectionList {
+        /**
+         * List items
+         */
+        items?: Collection[];
     }
     export interface Connection {
         /**
@@ -592,6 +591,10 @@ declare namespace bkper {
          * The unique id that identifies the Group in the Book
          */
         id?: string;
+        /**
+         * Tell if the group is locked by the Book owner
+         */
+        locked?: boolean;
         /**
          * Tell if has mixed type of accounts
          */
@@ -620,8 +623,6 @@ declare namespace bkper {
     export interface GroupBalances {
         accountBalances?: AccountBalances[];
         balances?: Balance[];
-        checkedCumulativeBalance?: string;
-        checkedPeriodBalance?: string;
         credit?: boolean;
         cumulativeBalance?: string;
         cumulativeCredit?: string;
@@ -636,8 +637,6 @@ declare namespace bkper {
         properties?: {
             [name: string]: string;
         };
-        uncheckedCumulativeBalance?: string;
-        uncheckedPeriodBalance?: string;
     }
     export interface GroupList {
         /**
@@ -702,11 +701,35 @@ declare namespace bkper {
          */
         items?: Query[];
     }
+    export interface Template {
+        bookId?: string;
+        bookLink?: string;
+        category?: string;
+        description?: string;
+        imageUrl?: string;
+        name?: string;
+        sheetsLink?: string;
+        timesUsed?: number; // int32
+    }
+    export interface TemplateList {
+        /**
+         * List items
+         */
+        items?: Template[];
+    }
     export interface Transaction {
         /**
          * The id of agent that created the resource
          */
         agentId?: string;
+        /**
+         * The agent logo that created the transaction
+         */
+        agentLogo?: string;
+        /**
+         * The agent name that created the transaction
+         */
+        agentName?: string;
         /**
          * The amount on format ####.##
          */
@@ -719,6 +742,10 @@ declare namespace bkper {
          * The creation timestamp, in milliseconds
          */
         createdAt?: string;
+        /**
+         * The actor username that created the transaction
+         */
+        createdBy?: string;
         creditAccount?: Account;
         /**
          * The date on ISO format yyyy-MM-dd
@@ -801,6 +828,10 @@ declare namespace bkper {
          * The user public avatar url
          */
         avatarUrl?: string;
+        /**
+         * True if user already had any bank connection
+         */
+        bankConnections?: boolean;
         /**
          * True if billing is enabled for the user
          */
@@ -852,6 +883,17 @@ declare namespace bkper {
     }
 }
 declare namespace Paths {
+    namespace BkperV5AddBooksToCollection {
+        export interface BodyParameters {
+            BookList: Parameters.BookList;
+        }
+        namespace Parameters {
+            export type BookList = bkper.BookList;
+        }
+        namespace Responses {
+            export type $200 = bkper.BookList;
+        }
+    }
     namespace BkperV5AddCollaborator {
         export interface BodyParameters {
             Collaborator: Parameters.Collaborator;
@@ -925,6 +967,17 @@ declare namespace Paths {
             export type $200 = bkper.App;
         }
     }
+    namespace BkperV5CreateCollection {
+        export interface BodyParameters {
+            Collection: Parameters.Collection;
+        }
+        namespace Parameters {
+            export type Collection = bkper.Collection;
+        }
+        namespace Responses {
+            export type $200 = bkper.Collection;
+        }
+    }
     namespace BkperV5CreateConnection {
         export interface BodyParameters {
             Connection: Parameters.Connection;
@@ -980,6 +1033,17 @@ declare namespace Paths {
             export type $200 = bkper.Integration;
         }
     }
+    namespace BkperV5CreateNewBook {
+        export interface BodyParameters {
+            Book: Parameters.Book;
+        }
+        namespace Parameters {
+            export type Book = bkper.Book;
+        }
+        namespace Responses {
+            export type $200 = bkper.Book;
+        }
+    }
     namespace BkperV5CreateTransaction {
         export interface BodyParameters {
             Transaction: Parameters.Transaction;
@@ -1007,6 +1071,11 @@ declare namespace Paths {
             export type $200 = bkper.Account;
         }
     }
+    namespace BkperV5DeleteCollection {
+        namespace Responses {
+            export type $200 = bkper.BookList;
+        }
+    }
     namespace BkperV5DeleteConnection {
         namespace Responses {
             export type $200 = bkper.Connection;
@@ -1102,6 +1171,11 @@ declare namespace Paths {
             export type $200 = bkper.BookList;
         }
     }
+    namespace BkperV5ListCollections {
+        namespace Responses {
+            export type $200 = bkper.CollectionList;
+        }
+    }
     namespace BkperV5ListConnectionIntegrations {
         namespace Responses {
             export type $200 = bkper.IntegrationList;
@@ -1137,6 +1211,11 @@ declare namespace Paths {
             export type $200 = bkper.QueryList;
         }
     }
+    namespace BkperV5ListTemplates {
+        namespace Responses {
+            export type $200 = bkper.TemplateList;
+        }
+    }
     namespace BkperV5ListTransactions {
         namespace Responses {
             export type $200 = bkper.TransactionList;
@@ -1164,6 +1243,17 @@ declare namespace Paths {
             export type $200 = bkper.TransactionOperation;
         }
     }
+    namespace BkperV5RemoveBooksFromCollection {
+        export interface BodyParameters {
+            BookList: Parameters.BookList;
+        }
+        namespace Parameters {
+            export type BookList = bkper.BookList;
+        }
+        namespace Responses {
+            export type $200 = bkper.BookList;
+        }
+    }
     namespace BkperV5RemoveCollaborator {
         namespace Responses {
             export type $200 = bkper.Collaborator;
@@ -1281,6 +1371,28 @@ declare namespace Paths {
             export type $200 = bkper.Book;
         }
     }
+    namespace BkperV5UpdateBookDeprecated {
+        export interface BodyParameters {
+            Book: Parameters.Book;
+        }
+        namespace Parameters {
+            export type Book = bkper.Book;
+        }
+        namespace Responses {
+            export type $200 = bkper.Book;
+        }
+    }
+    namespace BkperV5UpdateCollection {
+        export interface BodyParameters {
+            Collection: Parameters.Collection;
+        }
+        namespace Parameters {
+            export type Collection = bkper.Collection;
+        }
+        namespace Responses {
+            export type $200 = bkper.Collection;
+        }
+    }
     namespace BkperV5UpdateConnection {
         export interface BodyParameters {
             Connection: Parameters.Connection;
@@ -1332,5 +1444,8 @@ declare namespace Paths {
         namespace Parameters {
             export type TransactionList = bkper.TransactionList;
         }
+        namespace Responses {
+            export type $200 = bkper.TransactionList;
+        }
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bkper/bkper-api-types",
-  "version": "5.9.0",
+  "version": "5.11.0",
   "description": "Typescript definitions for Bkper REST API",
   "homepage": "https://api.bkper.com",
   "repository": {