@izak0s/spacebring-api 16.3.0 → 16.4.0

package/dist/index.d.cts

@@ -524,7 +524,7 @@ interface paths {
         };
         /**
          * Retrieve invoices
-         * @description Retrieve all invoices based on certain parameters. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["getInvoices"];
         put?: never;
@@ -696,7 +696,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -789,7 +789,7 @@ interface paths {
         };
         /**
          * Retrieve credit notes
-         * @description Retrieve all credit notes for a specific invoice or location. One of invoiceRef or locationRef is required. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["getCreditNotes"];
         put?: never;
@@ -28485,7 +28485,7 @@ interface operations {
                 "createDate[gte]"?: string;
                 /** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
                 "createDate[lte]"?: string;
-                /** @description UUID of the customer whose invoices to list. */
+                /** @description UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
                 customerRef?: string;
                 /** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
                 "issueDate[gte]"?: string;
@@ -28499,7 +28499,7 @@ interface operations {
                 membershipRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
-                /** @description Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
+                /** @description Case-insensitive search by invoice code or number. */
                 q?: string;
                 /** @description Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
                 status?: string;
@@ -28895,7 +28895,7 @@ interface operations {
                 "issueDate[lte]"?: string;
                 /** @description Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
                 limit?: number;
-                /** @description UUID of the location whose invoice items to list. */
+                /** @description UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
                 locationRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
@@ -29165,7 +29165,7 @@ interface operations {
                 invoiceRef?: string;
                 /** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
                 limit?: number;
-                /** @description UUID of the location whose credit notes to list. */
+                /** @description UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
                 locationRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
@@ -37281,7 +37281,7 @@ interface GetCreditNotesQuery {
     invoiceRef?: string;
     /** Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
     limit?: number;
-    /** UUID of the location whose credit notes to list. */
+    /** UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
     locationRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;
@@ -37296,7 +37296,7 @@ interface GetInvoicesQuery {
     "createDate[gte]"?: string;
     /** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
     "createDate[lte]"?: string;
-    /** UUID of the customer whose invoices to list. */
+    /** UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
     customerRef?: string;
     /** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
     "issueDate[gte]"?: string;
@@ -37310,7 +37310,7 @@ interface GetInvoicesQuery {
     membershipRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;
-    /** Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
+    /** Case-insensitive search by invoice code or number. */
     q?: string;
     /** Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
     status?: string;
@@ -37343,7 +37343,7 @@ interface ListInvoiceItemsQuery {
     "issueDate[lte]"?: string;
     /** Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
     limit?: number;
-    /** UUID of the location whose invoice items to list. */
+    /** UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
     locationRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;

package/dist/index.d.ts

@@ -524,7 +524,7 @@ interface paths {
         };
         /**
          * Retrieve invoices
-         * @description Retrieve all invoices based on certain parameters. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["getInvoices"];
         put?: never;
@@ -696,7 +696,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -789,7 +789,7 @@ interface paths {
         };
         /**
          * Retrieve credit notes
-         * @description Retrieve all credit notes for a specific invoice or location. One of invoiceRef or locationRef is required. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["getCreditNotes"];
         put?: never;
@@ -28485,7 +28485,7 @@ interface operations {
                 "createDate[gte]"?: string;
                 /** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
                 "createDate[lte]"?: string;
-                /** @description UUID of the customer whose invoices to list. */
+                /** @description UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
                 customerRef?: string;
                 /** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
                 "issueDate[gte]"?: string;
@@ -28499,7 +28499,7 @@ interface operations {
                 membershipRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
-                /** @description Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
+                /** @description Case-insensitive search by invoice code or number. */
                 q?: string;
                 /** @description Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
                 status?: string;
@@ -28895,7 +28895,7 @@ interface operations {
                 "issueDate[lte]"?: string;
                 /** @description Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
                 limit?: number;
-                /** @description UUID of the location whose invoice items to list. */
+                /** @description UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
                 locationRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
@@ -29165,7 +29165,7 @@ interface operations {
                 invoiceRef?: string;
                 /** @description Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
                 limit?: number;
-                /** @description UUID of the location whose credit notes to list. */
+                /** @description UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
                 locationRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
@@ -37281,7 +37281,7 @@ interface GetCreditNotesQuery {
     invoiceRef?: string;
     /** Maximum number of credit notes per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
     limit?: number;
-    /** UUID of the location whose credit notes to list. */
+    /** UUID of the location whose credit notes to list. Without invoiceRef or locationRef, lists the credit notes of the whole network. */
     locationRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;
@@ -37296,7 +37296,7 @@ interface GetInvoicesQuery {
     "createDate[gte]"?: string;
     /** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
     "createDate[lte]"?: string;
-    /** UUID of the customer whose invoices to list. */
+    /** UUID of the customer whose invoices to list. Without customerRef or locationRef, lists the invoices of the whole network. */
     customerRef?: string;
     /** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
     "issueDate[gte]"?: string;
@@ -37310,7 +37310,7 @@ interface GetInvoicesQuery {
     membershipRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;
-    /** Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
+    /** Case-insensitive search by invoice code or number. */
     q?: string;
     /** Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
     status?: string;
@@ -37343,7 +37343,7 @@ interface ListInvoiceItemsQuery {
     "issueDate[lte]"?: string;
     /** Maximum number of invoice items per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
     limit?: number;
-    /** UUID of the location whose invoice items to list. */
+    /** UUID of the location whose invoice items to list. Without customerRef, invoiceRef or locationRef, lists the invoice items of the whole network. */
     locationRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;

package/dist/index.js

@@ -778,7 +778,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");
@@ -786,7 +786,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(
@@ -847,7 +847,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");
@@ -855,7 +855,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(
@@ -985,7 +985,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");
@@ -993,7 +993,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(