@izak0s/spacebring-api 16.2.0 → 16.4.0

package/dist/index.cjs

@@ -805,7 +805,7 @@ function createBilling(client, defaults) {
       /**
        * Retrieve credit notes
        *
-       * Retrieve all credit notes for a specific invoice or location. One of invoiceRef or locationRef is required.
+       * Retrieve the credit notes of an invoice, a location, or the whole network when neither invoiceRef nor locationRef is set. An administrator limited to some locations needs invoiceRef or locationRef.
        */
       async list(query, options) {
         return unwrap(await client.GET("/billing/credit_notes/v1", { params: { query }, signal: options?.signal }), "GET /billing/credit_notes/v1");
@@ -813,7 +813,7 @@ function createBilling(client, defaults) {
       /**
        * Retrieve credit notes — iterates every item across all pages.
        *
-       * Retrieve all credit notes for a specific invoice or location. One of invoiceRef or locationRef is required.
+       * Retrieve the credit notes of an invoice, a location, or the whole network when neither invoiceRef nor locationRef is set. An administrator limited to some locations needs invoiceRef or locationRef.
        */
       iterate(query, options) {
         return paginate(
@@ -874,7 +874,7 @@ function createBilling(client, defaults) {
       /**
        * Retrieve invoices
        *
-       * Retrieve all invoices based on certain parameters.
+       * Retrieve the invoices of a customer, a location, or the whole network when neither customerRef nor locationRef is set. An administrator limited to some locations needs customerRef or locationRef.
        */
       async list(query, options) {
         return unwrap(await client.GET("/billing/invoices/v1", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1");
@@ -882,7 +882,7 @@ function createBilling(client, defaults) {
       /**
        * Retrieve invoices — iterates every item across all pages.
        *
-       * Retrieve all invoices based on certain parameters.
+       * Retrieve the invoices of a customer, a location, or the whole network when neither customerRef nor locationRef is set. An administrator limited to some locations needs customerRef or locationRef.
        */
       iterate(query, options) {
         return paginate(
@@ -1012,7 +1012,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items
          *
-         * 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.
+         * 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. Without customerRef, invoiceRef or locationRef, lists the items of the whole network; an administrator limited to some locations needs one of them.
          */
         async list(query, options) {
           return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
@@ -1020,7 +1020,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items — iterates every item across all pages.
          *
-         * 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.
+         * 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. Without customerRef, invoiceRef or locationRef, lists the items of the whole network; an administrator limited to some locations needs one of them.
          */
         iterate(query, options) {
           return paginate(
@@ -1133,7 +1133,7 @@ function createCheckins(client, defaults) {
     /**
      * Check in
      *
-     * Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. With bearer token authentication, the user must be an administrator of the location.
+     * Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. Add a past check-in date to a customer ref to record an arrival nobody checked the member in for: the member stays checked in until they check out, or, with a check-out date too, the check-in is created as checked out, without the events and webhooks of a live arrival. With bearer token authentication, the user must be an administrator of the location.
      */
     async checkIn(body, options) {
       return unwrapProp(await client.POST("/check_ins/v1/checkin", { body, signal: options?.signal }), "checkIn", "POST /check_ins/v1/checkin");