bkper-js 1.0.0 → 1.2.0

package/lib/index.d.ts

@@ -1,5 +1,5 @@
 /**
- * Bkper REST API Node client.
+ * Bkper REST API Javascript client for Node.js and browsers.
  *
  * Learn more at https://bkper.com/docs
  *
@@ -19,6 +19,7 @@
 export declare class Account {
 
 
+    constructor(book: Book, json?: bkper.Account);
     /**
      *
      * @returns The wrapped plain json object
@@ -27,11 +28,11 @@ export declare class Account {
     /**
      * Gets the account internal id.
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * Gets the account name.
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      *
      * Sets the name of the Account.
@@ -75,7 +76,7 @@ export declare class Account {
      *
      * @param keys - The property key
      */
-    getProperty(...keys: string[]): string;
+    getProperty(...keys: string[]): string | undefined;
     /**
      * Sets a custom property in the Account.
      *
@@ -84,7 +85,7 @@ export declare class Account {
      *
      * @returns This Account, for chainning.
      */
-    setProperty(key: string, value: string): Account;
+    setProperty(key: string, value: string | null): Account;
     /**
      * Delete a custom property
      *
@@ -108,7 +109,7 @@ export declare class Account {
     /**
      * Tell if this account is archived.
      */
-    isArchived(): boolean;
+    isArchived(): boolean | undefined;
     /**
      * Set account archived/unarchived.
      *
@@ -120,7 +121,7 @@ export declare class Account {
      *
      * Accounts with transaction posted, even with zero balance, can only be archived.
      */
-    hasTransactionPosted(): boolean;
+    hasTransactionPosted(): boolean | undefined;
     /**
      *
      * Tell if the account is permanent.
@@ -133,7 +134,7 @@ export declare class Account {
      *
      * @returns True if its a permanent Account
      */
-    isPermanent(): boolean;
+    isPermanent(): boolean | undefined;
     /**
      * Tell if the account has a Credit nature or Debit otherwise
      *
@@ -154,7 +155,7 @@ export declare class Account {
      *
      * As a rule of thumb, and for simple understanding, almost all accounts are Debit nature (NOT credit), except the ones that "offers" amount for the books, like revenue accounts.
      */
-    isCredit(): boolean;
+    isCredit(): boolean | undefined;
     /**
      * Get the [[Groups]] of this account.
      */
@@ -314,7 +315,7 @@ export declare class Amount {
  */
 export declare class App {
 
-    constructor(json: bkper.App);
+    constructor(json?: bkper.App);
     /**
      *
      * Sets the webhook url for development.
@@ -326,31 +327,31 @@ export declare class App {
      *
      * @returns The App universal identifier
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * Sets the whitelabeled user emails
      *
      * @returns This App for chaining
      */
-    setUserEmails(emails: string): App;
+    setUserEmails(emails?: string): App;
     /**
      * Sets the developer email
      *
      * @returns This App for chaining
      */
-    setDeveloperEmail(email: string): App;
+    setDeveloperEmail(email?: string): App;
     /**
      * Sets the client secret
      *
      * @returns This App for chaining
      */
-    setClientSecret(clientSecret: string): App;
+    setClientSecret(clientSecret?: string): App;
     /**
      * Sets the readme text
      *
      * @returns This App for chaining
      */
-    setReadme(readme: string): App;
+    setReadme(readme?: string): App;
     /**
      * Performs the app creation, applying pending changes.
      *
@@ -368,7 +369,7 @@ export declare class App {
 }
 
 /**
- * This is the main Entry Point of the [bkper-node](https://www.npmjs.com/package/bkper) library.
+ * This is the main Entry Point of the [bkper-js](https://www.npmjs.com/package/bkper-js) library.
  *
  * @public
  */
@@ -424,7 +425,7 @@ export declare class Book {
 
 
 
-    constructor(json: bkper.Book);
+    constructor(json?: bkper.Book);
     /**
      * @returns The wrapped plain json object
      */
@@ -436,7 +437,7 @@ export declare class Book {
     /**
      * @returns The name of this Book
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      *
      * Sets the name of the Book.
@@ -447,11 +448,11 @@ export declare class Book {
     /**
      * @returns The number of fraction digits supported by this Book. Same as getDecimalPlaces
      */
-    getFractionDigits(): number;
+    getFractionDigits(): number | undefined;
     /**
      * @returns The number of decimal places supported by this Book. Same as getFractionDigits
      */
-    getDecimalPlaces(): number;
+    getDecimalPlaces(): number | undefined;
     /**
      *
      * Sets the number of fraction digits (decimal places) supported by this Book
@@ -482,7 +483,7 @@ export declare class Book {
     /**
      * @returns The transactions pagination page size
      */
-    getPageSize(): number;
+    getPageSize(): number | undefined;
     /**
      * Sets the transactions pagination page size
      *
@@ -492,7 +493,7 @@ export declare class Book {
     /**
      * @returns The name of the owner of the Book
      */
-    getOwnerName(): string;
+    getOwnerName(): string | undefined;
     /**
      * @returns The permission for the current user
      */
@@ -500,11 +501,11 @@ export declare class Book {
     /**
      * @returns The collection of this book
      */
-    getCollection(): Collection;
+    getCollection(): Collection | undefined;
     /**
      * @returns The date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
      */
-    getDatePattern(): string;
+    getDatePattern(): string | undefined;
     /**
      *
      * Sets the date pattern of the Book. Current: dd/MM/yyyy | MM/dd/yyyy | yyyy/MM/dd
@@ -515,7 +516,7 @@ export declare class Book {
     /**
      * @returns The lock date of the Book in ISO format yyyy-MM-dd
      */
-    getLockDate(): string;
+    getLockDate(): string | undefined;
     /**
      *
      * Sets the lock date of the Book in ISO format yyyy-MM-dd.
@@ -526,7 +527,7 @@ export declare class Book {
     /**
      * @returns The closing date of the Book in ISO format yyyy-MM-dd
      */
-    getClosingDate(): string;
+    getClosingDate(): string | undefined;
     /**
      *
      * Sets the closing date of the Book in ISO format yyyy-MM-dd.
@@ -548,7 +549,7 @@ export declare class Book {
     /**
      * @returns The time zone of the Book
      */
-    getTimeZone(): string;
+    getTimeZone(): string | undefined;
     /**
      *
      * Sets the time zone of the Book
@@ -559,11 +560,11 @@ export declare class Book {
     /**
      * @returns The time zone offset of the book, in minutes
      */
-    getTimeZoneOffset(): number;
+    getTimeZoneOffset(): number | undefined;
     /**
      * @returns The last update date of the book, in in milliseconds
      */
-    getLastUpdateMs(): number;
+    getLastUpdateMs(): number | undefined;
     /**
      * Gets the custom properties stored in this Book
      */
@@ -575,7 +576,7 @@ export declare class Book {
      *
      * @param keys - The property key
      */
-    getProperty(...keys: string[]): string;
+    getProperty(...keys: string[]): string | undefined;
     /**
      * Sets the custom properties of the Book
      *
@@ -594,7 +595,7 @@ export declare class Book {
      *
      * @returns This Book, for chainning.
      */
-    setProperty(key: string, value: string): Book;
+    setProperty(key: string, value: string | null): Book;
     /**
      * Formats a date according to date pattern of the Book.
      *
@@ -621,7 +622,7 @@ export declare class Book {
     /**
      * Parse a value string according to [[DecimalSeparator]] and fraction digits of the Book.
      */
-    parseValue(value: string): Amount;
+    parseValue(value: string): Amount | undefined;
     /**
      * Rounds a value according to the number of fraction digits of the Book
      *
@@ -672,8 +673,6 @@ export declare class Book {
      * @returns a collection of transactions that remained in a previous iterator when the continuation token was generated
      */
     continueTransactionIterator(query: string, continuationToken: string): TransactionIterator;
-    configureTransactions_(transactions: Transaction[]): Transaction[];
-
     /**
      * Instantiate a new [[Transaction]]
      *
@@ -731,7 +730,7 @@ export declare class Book {
      *
      * @returns The matching Account object
      */
-    getAccount(idOrName: string): Promise<Account>;
+    getAccount(idOrName?: string): Promise<Account | undefined>;
 
     removeGroupCache(group: Group): void;
     /**
@@ -741,7 +740,7 @@ export declare class Book {
      *
      * @returns The matching Group object
      */
-    getGroup(idOrName: string): Promise<Group>;
+    getGroup(idOrName?: string): Promise<Group | undefined>;
     /**
      * Gets all [[Groups]] of this Book
      */
@@ -776,7 +775,7 @@ export declare class Book {
     /**
      * Retrieve a transaction by id
      */
-    getTransaction(id: string): Promise<Transaction>;
+    getTransaction(id: string): Promise<Transaction | undefined>;
     /**
      * Instantiate a new [[BkperFile]]
      *
@@ -811,11 +810,11 @@ export declare class Collection {
     /**
      * @returns The id of this Collection
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * @returns The name of this Collection
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      * @returns All Books of this collection.
      */
@@ -850,6 +849,17 @@ export declare interface Config {
      * Custom request error handler
      */
     requestErrorHandler?: (error: any) => any;
+    /**
+     * Custom request retry handler.
+     *
+     * This function is called when a request fails and needs to be retried.
+     * It provides the HTTP status code, error message, and the number of retry attempts made so far.
+     *
+     * @param code - The HTTP status code of the failed request.
+     * @param message - The error message associated with the failed request.
+     * @param attempt - The number of retry attempts made so far.
+     */
+    requestRetryHandler?: (status?: number, message?: string, attempt?: number) => Promise<void>;
     /**
      * Sets the base api url. Default to https://app.bkper.com/_ah/api/bkper
      */
@@ -875,13 +885,13 @@ export declare class Connection {
      *
      * @returns The Connection's id
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * Gets the agentId of the Connection.
      *
      * @returns The Connection's agentId
      */
-    getAgentId(): string;
+    getAgentId(): string | undefined;
     /**
      * Sets the Connection agentId.
      *
@@ -895,13 +905,13 @@ export declare class Connection {
      *
      * @returns The Connection name
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      * Gets the email of the owner of the Connection.
      *
      * @returns The Connection owner's email
      */
-    getEmail(): string;
+    getEmail(): string | undefined;
     /**
      * Sets the name of the Connection.
      *
@@ -923,13 +933,13 @@ export declare class Connection {
      *
      * @returns The Connection's universal unique identifier name
      */
-    getUUID(): string;
+    getUUID(): string | undefined;
     /**
      * Gets the type of the Connection.
      *
      * @returns The Connection type
      */
-    getType(): "APP" | "BANK";
+    getType(): "APP" | "BANK" | undefined;
     /**
      * Sets the Connection type.
      *
@@ -963,7 +973,7 @@ export declare class Connection {
      *
      * @returns The retrieved property value
      */
-    getProperty(...keys: string[]): string;
+    getProperty(...keys: string[]): string | undefined;
     /**
      * Sets a custom property in the Connection.
      *
@@ -972,7 +982,7 @@ export declare class Connection {
      *
      * @returns The Connection, for chaining
      */
-    setProperty(key: string, value: string): Connection;
+    setProperty(key: string, value: string | null): Connection;
     /**
      * Deletes a custom property stored in the Connection.
      *
@@ -1032,14 +1042,20 @@ export declare enum DecimalSeparator {
 export declare class File {
 
 
+    constructor(book: Book, json?: bkper.File);
+    /**
+     *
+     * @returns The wrapped plain json object
+     */
+    json(): bkper.Transaction;
     /**
      * Gets the File id
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * Gets the File name
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      *
      * Sets the name of the File.
@@ -1050,7 +1066,7 @@ export declare class File {
     /**
      * Gets the File content type
      */
-    getContentType(): string;
+    getContentType(): string | undefined;
     /**
      *
      * Sets the File content type.
@@ -1061,7 +1077,7 @@ export declare class File {
     /**
      * Gets the file content Base64 encoded
      */
-    getContent(): Promise<string>;
+    getContent(): Promise<string | undefined>;
     /**
      *
      * Sets the File content Base64 encoded.
@@ -1072,11 +1088,11 @@ export declare class File {
     /**
      * Gets the file serving url for accessing via browser
      */
-    getUrl(): string;
+    getUrl(): string | undefined;
     /**
      * Gets the file size in bytes
      */
-    getSize(): number;
+    getSize(): number | undefined;
     /**
      * Perform create new File.
      */
@@ -1094,8 +1110,9 @@ export declare class File {
  */
 export declare class Group {
 
-    accounts: Set<Account>;
 
+
+    constructor(book: Book, json?: bkper.Group);
     /**
      *
      * @returns The wrapped plain json object
@@ -1104,21 +1121,21 @@ export declare class Group {
     /**
      * @returns The id of this Group
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * @returns The parent Group
      */
-    getParent(): Promise<Group>;
+    getParent(): Promise<Group | undefined>;
     /**
      * Sets the parent Group.
      *
      * @returns This Group, for chainning.
      */
-    setParent(group: Group | null): Group;
+    setParent(group: Group | null | undefined): Group;
     /**
      * @returns The name of this Group
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      * Sets the name of the Group.
      *
@@ -1136,7 +1153,7 @@ export declare class Group {
     /**
      * @returns True if this group has any account in it
      */
-    hasAccounts(): boolean;
+    hasAccounts(): boolean | undefined;
     /**
      * @returns The type for of the accounts of this group. Null if mixed
      */
@@ -1162,14 +1179,14 @@ export declare class Group {
      *
      * @param keys - The property key
      */
-    getProperty(...keys: string[]): string;
+    getProperty(...keys: string[]): string | undefined;
     /**
      * Sets a custom property in the Group.
      *
      * @param key - The property key
      * @param value - The property value
      */
-    setProperty(key: string, value: string): Group;
+    setProperty(key: string, value: string | null): Group;
     /**
      * Delete a custom property
      *
@@ -1181,7 +1198,7 @@ export declare class Group {
     /**
      * Tell if the Group is hidden on main transactions menu
      */
-    isHidden(): boolean;
+    isHidden(): boolean | undefined;
     /**
      *  Hide/Show group on main menu.
      */
@@ -1207,7 +1224,7 @@ export declare class Group {
  */
 export declare class Integration {
 
-    constructor(json: bkper.Integration);
+    constructor(json?: bkper.Integration);
     /**
      * Gets the wrapped plain json object of the Integration.
      *
@@ -1219,19 +1236,19 @@ export declare class Integration {
      *
      * @returns The Integration's Book id
      */
-    getBookId(): string;
+    getBookId(): string | undefined;
     /**
      * Gets the id of the Integration.
      *
      * @returns This Integration's id
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * Gets the name of the Integration.
      *
      * @returns The Integration's name
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      * Gets the custom properties stored in the Integration.
      *
@@ -1257,7 +1274,7 @@ export declare class Integration {
      *
      * @returns The retrieved property value
      */
-    getProperty(...keys: string[]): string;
+    getProperty(...keys: string[]): string | undefined;
     /**
      * Sets a custom property in the Integration.
      *
@@ -1266,7 +1283,7 @@ export declare class Integration {
      *
      * @returns The Integration, for chaining
      */
-    setProperty(key: string, value: string): Integration;
+    setProperty(key: string, value: string | null): Integration;
     /**
      * Deletes a custom property stored in the Integration.
      *
@@ -1382,6 +1399,7 @@ export declare enum Permission {
 export declare class Transaction {
 
 
+    constructor(book: Book, json?: bkper.Transaction);
     /**
      *
      * @returns The wrapped plain json object
@@ -1390,11 +1408,11 @@ export declare class Transaction {
     /**
      * @returns The id of the Transaction.
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * @returns The id of the agent that created this transaction
      */
-    getAgentId(): string;
+    getAgentId(): string | undefined;
     /**
      * Remote ids are used to avoid duplication.
      *
@@ -1412,11 +1430,11 @@ export declare class Transaction {
     /**
      * @returns True if transaction was already posted to the accounts. False if is still a Draft.
      */
-    isPosted(): boolean;
+    isPosted(): boolean | undefined;
     /**
      * @returns True if transaction is checked.
      */
-    isChecked(): boolean;
+    isChecked(): boolean | undefined;
     /**
      * Set the check state of the Transaction.
      *
@@ -1428,7 +1446,7 @@ export declare class Transaction {
     /**
      * @returns True if transaction is in trash.
      */
-    isTrashed(): boolean;
+    isTrashed(): boolean | undefined;
     /**
      * @returns All #hashtags used on the transaction.
      */
@@ -1493,7 +1511,7 @@ export declare class Transaction {
      *
      * @param keys - The property key
      */
-    getProperty(...keys: string[]): string;
+    getProperty(...keys: string[]): string | undefined;
     /**
      * Gets the custom properties keys stored in this Transaction.
      */
@@ -1506,7 +1524,7 @@ export declare class Transaction {
      *
      * @returns This Transaction, for chainning.
      */
-    setProperty(key: string, value: string): Transaction;
+    setProperty(key: string, value: string | null): Transaction;
     /**
      * Delete a custom property
      *
@@ -1518,11 +1536,11 @@ export declare class Transaction {
     /**
      * @returns The credit account. The same as origin account.
      */
-    getCreditAccount(): Promise<Account>;
+    getCreditAccount(): Promise<Account | undefined>;
     /**
      * @returns The credit account name.
      */
-    getCreditAccountName(): Promise<string>;
+    getCreditAccountName(): Promise<string | undefined>;
     /**
      *
      * Sets the credit/origin Account of the Transaction. Same as from().
@@ -1545,11 +1563,11 @@ export declare class Transaction {
      * @returns The debit account. The same as destination account.
      *
      */
-    getDebitAccount(): Promise<Account>;
+    getDebitAccount(): Promise<Account | undefined>;
     /**
      * @returns The debit account name.
      */
-    getDebitAccountName(): Promise<string>;
+    getDebitAccountName(): Promise<string | undefined>;
     /**
      *
      * Sets the debit/destination Account of the Transaction. Same as to().
@@ -1571,7 +1589,7 @@ export declare class Transaction {
     /**
      * @returns The amount of the transaction.
      */
-    getAmount(): Amount;
+    getAmount(): Amount | undefined;
     /**
      *
      * Sets the amount of the Transaction.
@@ -1584,40 +1602,40 @@ export declare class Transaction {
      *
      * @param account - The account object, id or name.
      */
-    getCreditAmount(account: Account | string): Promise<Amount>;
+    getCreditAmount(account: Account | string): Promise<Amount | undefined>;
     /**
      * Gets the absolute amount of this transaction if the given account is at the debit side, else null.
      *
      * @param account - The account object, id or name.
      */
-    getDebitAmount(account: Account | string): Promise<Amount>;
+    getDebitAmount(account: Account | string): Promise<Amount | undefined>;
     /**
      * Gets the [[Account]] at the other side of the transaction given the one in one side.
      *
      * @param account - The account object, id or name.
      */
-    getOtherAccount(account: Account | string): Promise<Account>;
+    getOtherAccount(account: Account | string): Promise<Account | undefined>;
     /**
      *
      * The account name at the other side of the transaction given the one in one side.
      *
      * @param account - The account object, id or name.
      */
-    getOtherAccountName(account: string | Account): Promise<string>;
+    getOtherAccountName(account: string | Account): Promise<string | undefined>;
     /**
      *
      * Tell if the given account is credit on the transaction
      *
      * @param account - The account object
      */
-    isCredit(account: Account): Promise<boolean>;
+    isCredit(account?: Account): Promise<boolean>;
     /**
      *
      * Tell if the given account is debit on the transaction
      *
      * @param account - The account object
      */
-    isDebit(account: Account): Promise<boolean>;
+    isDebit(account?: Account): Promise<boolean>;
 
     /**
      * @returns The description of this transaction.
@@ -1633,7 +1651,7 @@ export declare class Transaction {
     /**
      * @returns The Transaction date, in ISO format yyyy-MM-dd.
      */
-    getDate(): string;
+    getDate(): string | undefined;
     /**
      *
      * Sets the date of the Transaction.
@@ -1648,11 +1666,11 @@ export declare class Transaction {
     /**
      * @returns The Transaction date number, in format YYYYMMDD.
      */
-    getDateValue(): number;
+    getDateValue(): number | undefined;
     /**
      * @returns The Transaction date, formatted on the date pattern of the [[Book]].
      */
-    getDateFormatted(): string;
+    getDateFormatted(): string | undefined;
     /**
      * @returns The date the transaction was created.
      */
@@ -1672,7 +1690,7 @@ export declare class Transaction {
      *
      * @param raw - True to get the raw balance, no matter the credit nature of the [[Account]].
      */
-    getAccountBalance(raw?: boolean): Promise<Amount>;
+    getAccountBalance(raw?: boolean): Promise<Amount | undefined>;
     /**
      * Perform create new draft transaction.
      */
@@ -1740,7 +1758,7 @@ export declare class TransactionIterator {
      *
      * Continuation tokens are generally valid short period of time.
      */
-    getContinuationToken(): string;
+    getContinuationToken(): string | undefined;
     /**
      * Sets a continuation token from previous paused iteration
      */
@@ -1752,11 +1770,11 @@ export declare class TransactionIterator {
     /**
      * Gets the next transaction in the collection of transactions.
      */
-    next(): Promise<Transaction>;
+    next(): Promise<Transaction | undefined>;
     /**
      * @returns The account, when filtering by a single account.
      */
-    getAccount(): Promise<Account>;
+    getAccount(): Promise<Account | undefined>;
 }
 
 /**
@@ -1766,25 +1784,25 @@ export declare class TransactionIterator {
  */
 export declare class User {
 
-    constructor(wrapped: bkper.User);
+    constructor(json?: bkper.User);
     /**
      * Gets the id of the User.
      *
      * @returns The User's id
      */
-    getId(): string;
+    getId(): string | undefined;
     /**
      * Gets the name of the User.
      *
      * @returns The User's name
      */
-    getName(): string;
+    getName(): string | undefined;
     /**
      * Gets the full name of the User.
      *
      * @returns The User's full name
      */
-    getFullName(): string;
+    getFullName(): string | undefined;
     /**
      * Gets the [[Connections]] of the User.
      *