@izak0s/spacebring-api 10.6.0 → 11.1.0

package/README.md

@@ -15,7 +15,7 @@ A fully-typed TypeScript client for the [Spacebring](https://www.spacebring.com)
 
 ## Features
 
-- **<!-- coverage -->209 operations across 22 resource groups<!-- /coverage -->** — the full Spacebring API surface
+- **<!-- coverage -->208 operations across 22 resource groups<!-- /coverage -->** — the full Spacebring API surface
 - **Auto-generated** from the official OpenAPI spec — types and facade regenerate anytime the spec changes
 - **Nested, discoverable API** — `sb.billing.invoices.pay(id)`, `sb.visitors.visits.checkIn(body)`
 - **Auto-pagination** — every paginated list endpoint has an `iterate()` async generator that walks `nextPageToken` for you

package/dist/index.cjs

@@ -922,17 +922,6 @@ function createBilling(client, defaults) {
       async duplicate(invoiceId, options) {
         return unwrapProp(await client.POST("/billing/invoices/v1/{invoiceId}/duplicate", { params: { path: { invoiceId } }, signal: options?.signal }), "invoice", "POST /billing/invoices/v1/{invoiceId}/duplicate");
       },
-      /**
-       * List invoice items
-       *
-       * List all items for a specific invoice.
-       *
-       * @param invoiceId The id of an invoice.
-       * @param options Request options (abort signal).
-       */
-      async getItems(invoiceId, options) {
-        return unwrap(await client.GET("/billing/invoices/v1/{invoiceId}/items", { params: { path: { invoiceId } }, signal: options?.signal }), "GET /billing/invoices/v1/{invoiceId}/items");
-      },
       /**
        * Retrieve the upcoming invoice
        *
@@ -991,7 +980,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items
          *
-         * List invoice items filtered by customer, location, type, status, pending, or date range. Status and issue date filters match items connected to an invoice. Pending items are not on an invoice and not part of a subscription.
+         * List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer's pending items, or with locationRef for every pending item at a location.
          */
         async list(query, options) {
           return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
@@ -999,7 +988,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items — iterates every item across all pages.
          *
-         * List invoice items filtered by customer, location, type, status, pending, or date range. Status and issue date filters match items connected to an invoice. Pending items are not on an invoice and not part of a subscription.
+         * List invoice items filtered by customer, location, invoice, type, status, pending, or date range. Pass invoiceRef for the items of one invoice; they page like the rest of the list. The createDate filter matches when the item was created; the status and issueDate filters match the invoice the item is on, so they return only items connected to an invoice. Pending items are not on an invoice and not part of a subscription: pass pending=true with customerRef for one customer's pending items, or with locationRef for every pending item at a location.
          */
         iterate(query, options) {
           return paginate(
@@ -1049,7 +1038,13 @@ function createBilling(client, defaults) {
         async delete(id, options) {
           return unwrap(await client.DELETE("/billing/invoices/v1/items/{id}", { params: { path: { id } }, signal: options?.signal }), "DELETE /billing/invoices/v1/items/{id}");
         },
-        /** List upcoming invoice items */
+        /**
+         * List upcoming invoice items
+         *
+         * List a customer's pending invoice items. Deprecated: use List invoice items with `pending=true` and `customerRef` instead.
+         *
+         * @deprecated Marked as deprecated in the OpenAPI spec.
+         */
         async getUpcoming(query, options) {
           return unwrapProp(await client.GET("/billing/invoices/v1/items/upcoming", { params: { query }, signal: options?.signal }), "invoiceItems", "GET /billing/invoices/v1/items/upcoming");
         }