bexio 4.0.0 → 4.0.1

package/lib/index.d.mts

@@ -873,6 +873,7 @@ declare namespace OrdersStatic {
 
 declare namespace PositionsStatic {
     type KbDocumentType = "kb_invoice" | "kb_offer" | "kb_order";
+    type PositionType = "KbPositionCustom" | "KbPositionArticle" | "KbPositionText" | "KbPositionSubtotal" | "KbPositionPagebreak" | "KbPositionDiscount" | "KbPositionSubposition";
     interface DefaultPositionCreate {
         amount: string;
         amount_reserved: string;
@@ -918,6 +919,42 @@ declare namespace PositionsStatic {
     }
 }
 
+declare namespace PositionStatic {
+    interface PositionCreate {
+        amount?: string;
+        unit_id?: number;
+        account_id?: number;
+        tax_id?: number;
+        text: string;
+        unit_price?: string;
+        discount_in_percent?: string;
+        type: string;
+        parent_id?: number | null;
+        article_id?: number;
+        show_pos_nr?: boolean;
+        is_percentual?: boolean;
+        value?: string;
+    }
+    interface Position {
+        id: number;
+        type: PositionsStatic.PositionType;
+        amount: string;
+        unit_id: number;
+        account_id: number;
+        unit_name: string;
+        tax_id: number;
+        tax_value: string;
+        text: string;
+        unit_price: string;
+        discount_in_percent: string | null;
+        position_total: string;
+        pos: string;
+        internal_pos: number;
+        parent_id: number | null;
+        is_optional: boolean;
+    }
+}
+
 declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.OrderFull, OrdersStatic.OrderSmall, OrdersStatic.OrderSearchParameters, OrdersStatic.OrderCreate, OrdersStatic.OrderCreate> {
     constructor(apiToken: string);
     /**
@@ -947,6 +984,42 @@ declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.Orde
      * @memberof Orders
      */
     createTextPosition(orderId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
+    /**
+     * Delete a default position for an order
+     *
+     * @param {number} orderId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deleteDefaultPosition(orderId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete an item position for an order
+     *
+     * @param {number} orderId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deleteItemPosition(orderId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a text position for an order
+     *
+     * @param {number} orderId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deleteTextPosition(orderId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a position for an order, whatever its type
+     *
+     * @param {number} orderId
+     * @param {Pick<PositionStatic.Position, "id" | "type">} position
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deletePosition(orderId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
 }
 
 declare namespace ProjectsStatic {
@@ -1423,42 +1496,6 @@ declare class Items extends BaseCrud<ItemsStatic.Item, ItemsStatic.Item, ItemsSt
     constructor(apiToken: string);
 }
 
-declare namespace PositionStatic {
-    interface PositionCreate {
-        amount?: string;
-        unit_id?: number;
-        account_id?: number;
-        tax_id?: number;
-        text: string;
-        unit_price?: string;
-        discount_in_percent?: string;
-        type: string;
-        parent_id?: number | null;
-        article_id?: number;
-        show_pos_nr?: boolean;
-        is_percentual?: boolean;
-        value?: string;
-    }
-    interface Position {
-        id: number;
-        type: string;
-        amount: string;
-        unit_id: number;
-        account_id: number;
-        unit_name: string;
-        tax_id: number;
-        tax_value: string;
-        text: string;
-        unit_price: string;
-        discount_in_percent: null;
-        position_total: string;
-        pos: string;
-        internal_pos: number;
-        parent_id: null;
-        is_optional: false;
-    }
-}
-
 declare namespace InvoicesStatic {
     interface Invoice {
         id: number;
@@ -1508,6 +1545,7 @@ declare namespace InvoicesStatic {
         title?: string | null;
         contact_id: number;
         contact_sub_id?: number | null;
+        contact_address_manual?: string | null;
         user_id: number;
         pr_project_id?: number | null;
         logopaper_id?: number;
@@ -1531,6 +1569,7 @@ declare namespace InvoicesStatic {
         title?: string | null;
         contact_id?: number;
         contact_sub_id?: number | null;
+        contact_address_manual?: string | null;
         user_id?: number;
         pr_project_id?: number | null;
         logopaper_id?: number;
@@ -1729,6 +1768,42 @@ declare class Invoices extends BaseCrud<InvoicesStatic.Invoice, InvoicesStatic.I
      * @memberof Invoices
      */
     createTextPosition(invoiceId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
+    /**
+     * Delete a default position for an invoice
+     *
+     * @param {number} invoiceId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deleteDefaultPosition(invoiceId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete an item position for an invoice
+     *
+     * @param {number} invoiceId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deleteItemPosition(invoiceId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a text position for an invoice
+     *
+     * @param {number} invoiceId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deleteTextPosition(invoiceId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a position for an invoice, whatever its type
+     *
+     * @param {number} invoiceId
+     * @param {Pick<PositionStatic.Position, "id" | "type">} position
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deletePosition(invoiceId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
 }
 
 declare namespace CurrenciesStatic {

package/lib/index.d.ts

@@ -873,6 +873,7 @@ declare namespace OrdersStatic {
 
 declare namespace PositionsStatic {
     type KbDocumentType = "kb_invoice" | "kb_offer" | "kb_order";
+    type PositionType = "KbPositionCustom" | "KbPositionArticle" | "KbPositionText" | "KbPositionSubtotal" | "KbPositionPagebreak" | "KbPositionDiscount" | "KbPositionSubposition";
     interface DefaultPositionCreate {
         amount: string;
         amount_reserved: string;
@@ -918,6 +919,42 @@ declare namespace PositionsStatic {
     }
 }
 
+declare namespace PositionStatic {
+    interface PositionCreate {
+        amount?: string;
+        unit_id?: number;
+        account_id?: number;
+        tax_id?: number;
+        text: string;
+        unit_price?: string;
+        discount_in_percent?: string;
+        type: string;
+        parent_id?: number | null;
+        article_id?: number;
+        show_pos_nr?: boolean;
+        is_percentual?: boolean;
+        value?: string;
+    }
+    interface Position {
+        id: number;
+        type: PositionsStatic.PositionType;
+        amount: string;
+        unit_id: number;
+        account_id: number;
+        unit_name: string;
+        tax_id: number;
+        tax_value: string;
+        text: string;
+        unit_price: string;
+        discount_in_percent: string | null;
+        position_total: string;
+        pos: string;
+        internal_pos: number;
+        parent_id: number | null;
+        is_optional: boolean;
+    }
+}
+
 declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.OrderFull, OrdersStatic.OrderSmall, OrdersStatic.OrderSearchParameters, OrdersStatic.OrderCreate, OrdersStatic.OrderCreate> {
     constructor(apiToken: string);
     /**
@@ -947,6 +984,42 @@ declare class Orders extends BaseCrud<OrdersStatic.OrderSmall, OrdersStatic.Orde
      * @memberof Orders
      */
     createTextPosition(orderId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
+    /**
+     * Delete a default position for an order
+     *
+     * @param {number} orderId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deleteDefaultPosition(orderId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete an item position for an order
+     *
+     * @param {number} orderId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deleteItemPosition(orderId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a text position for an order
+     *
+     * @param {number} orderId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deleteTextPosition(orderId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a position for an order, whatever its type
+     *
+     * @param {number} orderId
+     * @param {Pick<PositionStatic.Position, "id" | "type">} position
+     * @returns {Promise<boolean>}
+     * @memberof Orders
+     */
+    deletePosition(orderId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
 }
 
 declare namespace ProjectsStatic {
@@ -1423,42 +1496,6 @@ declare class Items extends BaseCrud<ItemsStatic.Item, ItemsStatic.Item, ItemsSt
     constructor(apiToken: string);
 }
 
-declare namespace PositionStatic {
-    interface PositionCreate {
-        amount?: string;
-        unit_id?: number;
-        account_id?: number;
-        tax_id?: number;
-        text: string;
-        unit_price?: string;
-        discount_in_percent?: string;
-        type: string;
-        parent_id?: number | null;
-        article_id?: number;
-        show_pos_nr?: boolean;
-        is_percentual?: boolean;
-        value?: string;
-    }
-    interface Position {
-        id: number;
-        type: string;
-        amount: string;
-        unit_id: number;
-        account_id: number;
-        unit_name: string;
-        tax_id: number;
-        tax_value: string;
-        text: string;
-        unit_price: string;
-        discount_in_percent: null;
-        position_total: string;
-        pos: string;
-        internal_pos: number;
-        parent_id: null;
-        is_optional: false;
-    }
-}
-
 declare namespace InvoicesStatic {
     interface Invoice {
         id: number;
@@ -1508,6 +1545,7 @@ declare namespace InvoicesStatic {
         title?: string | null;
         contact_id: number;
         contact_sub_id?: number | null;
+        contact_address_manual?: string | null;
         user_id: number;
         pr_project_id?: number | null;
         logopaper_id?: number;
@@ -1531,6 +1569,7 @@ declare namespace InvoicesStatic {
         title?: string | null;
         contact_id?: number;
         contact_sub_id?: number | null;
+        contact_address_manual?: string | null;
         user_id?: number;
         pr_project_id?: number | null;
         logopaper_id?: number;
@@ -1729,6 +1768,42 @@ declare class Invoices extends BaseCrud<InvoicesStatic.Invoice, InvoicesStatic.I
      * @memberof Invoices
      */
     createTextPosition(invoiceId: number, position: PositionsStatic.TextPositionCreate): Promise<PositionsStatic.TextPosition>;
+    /**
+     * Delete a default position for an invoice
+     *
+     * @param {number} invoiceId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deleteDefaultPosition(invoiceId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete an item position for an invoice
+     *
+     * @param {number} invoiceId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deleteItemPosition(invoiceId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a text position for an invoice
+     *
+     * @param {number} invoiceId
+     * @param {number} positionId
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deleteTextPosition(invoiceId: number, positionId: number): Promise<boolean>;
+    /**
+     * Delete a position for an invoice, whatever its type
+     *
+     * @param {number} invoiceId
+     * @param {Pick<PositionStatic.Position, "id" | "type">} position
+     * @returns {Promise<boolean>}
+     * @memberof Invoices
+     */
+    deletePosition(invoiceId: number, position: Pick<PositionStatic.Position, "id" | "type">): Promise<boolean>;
 }
 
 declare namespace CurrenciesStatic {

package/lib/index.js

@@ -616,6 +616,64 @@ var TextPositions = class extends BaseCrud {
   }
 };
 
+// src/resources/Positions.ts
+var Positions = class _Positions extends BaseCrud {
+  static {
+    this.endpoints = {
+      KbPositionCustom: "kb_position_custom",
+      KbPositionArticle: "kb_position_article",
+      KbPositionText: "kb_position_text",
+      KbPositionSubtotal: "kb_position_subtotal",
+      KbPositionPagebreak: "kb_position_pagebreak",
+      KbPositionDiscount: "kb_position_discount",
+      KbPositionSubposition: "kb_position_subposition"
+    };
+  }
+  constructor(apiToken, documentType, documentId, positionType) {
+    super(
+      apiToken,
+      `/2.0/${documentType}/${documentId}/${_Positions.endpoint(positionType)}`
+    );
+  }
+  /**
+   * Endpoint segment of a position type
+   *
+   * @private
+   * @static
+   * @param {PositionsStatic.PositionType} positionType
+   * @returns {string}
+   * @memberof Positions
+   */
+  static endpoint(positionType) {
+    if (!Object.prototype.hasOwnProperty.call(_Positions.endpoints, positionType)) {
+      throw new Error(`Unknown position type "${positionType}"`);
+    }
+    return _Positions.endpoints[positionType];
+  }
+  /**
+   * Not implemented by Bexio yet
+   *
+   * @param {Array<BaseStatic.SearchParameter<{}>>} searchOptions
+   * @param {BaseStatic.BaseOptions} [options]
+   * @returns {Promise<Array<{}>>}
+   * @memberof Positions
+   */
+  async search(searchOptions, options) {
+    throw new Error("not implemented by Bexio yet");
+  }
+  /**
+   * Not implemented by Bexio yet
+   *
+   * @param {number} id
+   * @param {{}} ressource
+   * @returns {Promise<PositionStatic.Position>}
+   * @memberof Positions
+   */
+  async overwrite(id, ressource) {
+    throw new Error("not implemented by Bexio yet");
+  }
+};
+
 // src/resources/Orders.ts
 var Orders = class extends BaseCrud {
   constructor(apiToken) {
@@ -660,6 +718,61 @@ var Orders = class extends BaseCrud {
       position
     );
   }
+  /**
+   * Delete a default position for an order
+   *
+   * @param {number} orderId
+   * @param {number} positionId
+   * @returns {Promise<boolean>}
+   * @memberof Orders
+   */
+  async deleteDefaultPosition(orderId, positionId) {
+    return new DefaultPositions(this.apiToken, "kb_order", orderId).delete(
+      positionId
+    );
+  }
+  /**
+   * Delete an item position for an order
+   *
+   * @param {number} orderId
+   * @param {number} positionId
+   * @returns {Promise<boolean>}
+   * @memberof Orders
+   */
+  async deleteItemPosition(orderId, positionId) {
+    return new ItemPositions(this.apiToken, "kb_order", orderId).delete(
+      positionId
+    );
+  }
+  /**
+   * Delete a text position for an order
+   *
+   * @param {number} orderId
+   * @param {number} positionId
+   * @returns {Promise<boolean>}
+   * @memberof Orders
+   */
+  async deleteTextPosition(orderId, positionId) {
+    return new TextPositions(this.apiToken, "kb_order", orderId).delete(
+      positionId
+    );
+  }
+  /**
+   * Delete a position for an order, whatever its type
+   *
+   * @param {number} orderId
+   * @param {Pick<PositionStatic.Position, "id" | "type">} position
+   * @returns {Promise<boolean>}
+   * @memberof Orders
+   */
+  async deletePosition(orderId, position) {
+    return new Positions(
+      this.apiToken,
+      "kb_order",
+      orderId,
+      position.type
+    ).delete(position.id);
+  }
 };
 
 // src/resources/Projects.ts
@@ -1072,6 +1185,61 @@ var Invoices = class extends BaseCrud {
       position
     );
   }
+  /**
+   * Delete a default position for an invoice
+   *
+   * @param {number} invoiceId
+   * @param {number} positionId
+   * @returns {Promise<boolean>}
+   * @memberof Invoices
+   */
+  async deleteDefaultPosition(invoiceId, positionId) {
+    return new DefaultPositions(this.apiToken, "kb_invoice", invoiceId).delete(
+      positionId
+    );
+  }
+  /**
+   * Delete an item position for an invoice
+   *
+   * @param {number} invoiceId
+   * @param {number} positionId
+   * @returns {Promise<boolean>}
+   * @memberof Invoices
+   */
+  async deleteItemPosition(invoiceId, positionId) {
+    return new ItemPositions(this.apiToken, "kb_invoice", invoiceId).delete(
+      positionId
+    );
+  }
+  /**
+   * Delete a text position for an invoice
+   *
+   * @param {number} invoiceId
+   * @param {number} positionId
+   * @returns {Promise<boolean>}
+   * @memberof Invoices
+   */
+  async deleteTextPosition(invoiceId, positionId) {
+    return new TextPositions(this.apiToken, "kb_invoice", invoiceId).delete(
+      positionId
+    );
+  }
+  /**
+   * Delete a position for an invoice, whatever its type
+   *
+   * @param {number} invoiceId
+   * @param {Pick<PositionStatic.Position, "id" | "type">} position
+   * @returns {Promise<boolean>}
+   * @memberof Invoices
+   */
+  async deletePosition(invoiceId, position) {
+    return new Positions(
+      this.apiToken,
+      "kb_invoice",
+      invoiceId,
+      position.type
+    ).delete(position.id);
+  }
 };
 
 // src/resources/Currencies.ts