@izak0s/spacebring-api 11.0.0 → 11.2.0

package/dist/index.d.cts

@@ -688,7 +688,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @description List invoice items filtered by customer, location, type, status, pending, or date range. 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -11727,6 +11727,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -12157,6 +12162,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -12799,6 +12809,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -13229,6 +13244,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -27958,6 +27978,8 @@ interface operations {
                  *     - **voided** — cancelled and no longer valid
                  */
                 status?: string;
+                /** @description UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
+                invoiceRef?: string;
                 /** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
                 pending?: "true" | "false";
                 /** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
@@ -33957,9 +33979,9 @@ interface operations {
                 membershipRef?: string;
                 /** @description Token to retrieve the next page of results. */
                 nextPageToken?: string;
-                /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+                /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
                 status?: string;
-                /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+                /** @description Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
                 type?: string;
             };
             header?: {
@@ -34120,7 +34142,7 @@ interface operations {
                 membershipRef?: string;
                 /** @description Token to retrieve the next page of results. */
                 nextPageToken?: string;
-                /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+                /** @description Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
                 type?: string;
             };
             header?: {
@@ -34236,9 +34258,9 @@ interface operations {
                 locationRef?: string;
                 /** @description Token to retrieve the next page of results. */
                 nextPageToken?: string;
-                /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+                /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
                 status?: string;
-                /** @description Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
+                /** @description Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
                 type?: string;
             };
             header?: {
@@ -34810,6 +34832,8 @@ interface operations {
                 locationRef: string;
                 /** @description The id of the user, host of the visit. */
                 userRefHost?: string;
+                /** @description The id of the user, visitor of the visit. */
+                userRefVisitor?: string;
                 /** @description The date filter of items. */
                 createDate?: {
                     /**
@@ -35119,6 +35143,8 @@ interface GetVisitsQuery {
     locationRef: string;
     /** The id of the user, host of the visit. */
     userRefHost?: string;
+    /** The id of the user, visitor of the visit. */
+    userRefVisitor?: string;
     /** The date filter of items. */
     createDate?: {
         lte?: string;
@@ -35179,9 +35205,9 @@ interface GetCreditsTransactionsQuery {
     membershipRef?: string;
     /** Token to retrieve the next page of results. */
     nextPageToken?: string;
-    /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+    /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
     status?: string;
-    /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+    /** Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
     type?: string;
 }
 /** Query parameters for `sb.transactions.dayPasses.list()`. */
@@ -35202,7 +35228,7 @@ interface GetDayPassesTransactionsQuery {
     membershipRef?: string;
     /** Token to retrieve the next page of results. */
     nextPageToken?: string;
-    /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+    /** Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
     type?: string;
 }
 /** Query parameters for `sb.transactions.money.list()`. */
@@ -35219,9 +35245,9 @@ interface GetMoneyTransactionsQuery {
     locationRef?: string;
     /** Token to retrieve the next page of results. */
     nextPageToken?: string;
-    /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+    /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
     status?: string;
-    /** Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
+    /** Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
     type?: string;
 }
 /** Query parameters for `sb.transactions.credits.scheduled.list()`. */
@@ -35951,6 +35977,8 @@ interface ListInvoiceItemsQuery {
     - **paid** — fully paid
     - **voided** — cancelled and no longer valid */
     status?: string;
+    /** UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
+    invoiceRef?: string;
     /** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
     pending?: "true" | "false";
     /** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */

package/dist/index.d.ts

@@ -688,7 +688,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @description List invoice items filtered by customer, location, type, status, pending, or date range. 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -11727,6 +11727,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -12157,6 +12162,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -12799,6 +12809,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -13229,6 +13244,11 @@ interface components {
                             };
                             /** @description ID of the invoice item the booking was billed on. */
                             invoiceItemRef?: string;
+                            /**
+                             * Format: uuid
+                             * @description Invoice the invoice item was added to. Not set while the item is pending.
+                             */
+                            invoiceRef?: string;
                             /**
                              * Format: uuid
                              * @description Subscription the invoice item belongs to.
@@ -27958,6 +27978,8 @@ interface operations {
                  *     - **voided** — cancelled and no longer valid
                  */
                 status?: string;
+                /** @description UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
+                invoiceRef?: string;
                 /** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
                 pending?: "true" | "false";
                 /** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
@@ -33957,9 +33979,9 @@ interface operations {
                 membershipRef?: string;
                 /** @description Token to retrieve the next page of results. */
                 nextPageToken?: string;
-                /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+                /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
                 status?: string;
-                /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+                /** @description Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
                 type?: string;
             };
             header?: {
@@ -34120,7 +34142,7 @@ interface operations {
                 membershipRef?: string;
                 /** @description Token to retrieve the next page of results. */
                 nextPageToken?: string;
-                /** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+                /** @description Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
                 type?: string;
             };
             header?: {
@@ -34236,9 +34258,9 @@ interface operations {
                 locationRef?: string;
                 /** @description Token to retrieve the next page of results. */
                 nextPageToken?: string;
-                /** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+                /** @description Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
                 status?: string;
-                /** @description Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
+                /** @description Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
                 type?: string;
             };
             header?: {
@@ -34810,6 +34832,8 @@ interface operations {
                 locationRef: string;
                 /** @description The id of the user, host of the visit. */
                 userRefHost?: string;
+                /** @description The id of the user, visitor of the visit. */
+                userRefVisitor?: string;
                 /** @description The date filter of items. */
                 createDate?: {
                     /**
@@ -35119,6 +35143,8 @@ interface GetVisitsQuery {
     locationRef: string;
     /** The id of the user, host of the visit. */
     userRefHost?: string;
+    /** The id of the user, visitor of the visit. */
+    userRefVisitor?: string;
     /** The date filter of items. */
     createDate?: {
         lte?: string;
@@ -35179,9 +35205,9 @@ interface GetCreditsTransactionsQuery {
     membershipRef?: string;
     /** Token to retrieve the next page of results. */
     nextPageToken?: string;
-    /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+    /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
     status?: string;
-    /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+    /** Filter by what moved the credits: allocations add credits ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking', 'order', 'eventTicket' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused credits. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, eventTicket, expiration, order, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
     type?: string;
 }
 /** Query parameters for `sb.transactions.dayPasses.list()`. */
@@ -35202,7 +35228,7 @@ interface GetDayPassesTransactionsQuery {
     membershipRef?: string;
     /** Token to retrieve the next page of results. */
     nextPageToken?: string;
-    /** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
+    /** Filter by what moved the day passes: allocations add passes ('adminAllocation' granted by an admin, 'subscriptionAllocation' from a plan, 'purchaseAllocation' from a bought package); 'booking' and 'adminCharge' spend them; 'refund' returns them; 'expiration' and 'subscriptionExpiration' remove unused passes. Matches analytics report type filters. Comma-separated, one or more of: adminAllocation, adminCharge, booking, expiration, purchaseAllocation, refund, subscriptionAllocation, subscriptionExpiration. */
     type?: string;
 }
 /** Query parameters for `sb.transactions.money.list()`. */
@@ -35219,9 +35245,9 @@ interface GetMoneyTransactionsQuery {
     locationRef?: string;
     /** Token to retrieve the next page of results. */
     nextPageToken?: string;
-    /** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
+    /** Filter by payment status: 'succeeded' completed, 'pending' awaiting payment, 'processing' being settled by the gateway, 'failed' did not go through, 'canceled' called off before completion. Comma-separated, one or more of: canceled, failed, pending, processing, succeeded. */
     status?: string;
-    /** Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
+    /** Filter by what was paid for: 'booking' a resource, 'creditPackage' a credits or day passes package, 'eventTicket' an event ticket, 'invoice' an issued invoice, 'order' a shop order, 'subscription' a membership plan, 'custom' a one-off charge created by an admin. Comma-separated, one or more of: booking, creditPackage, custom, eventTicket, invoice, order, subscription. */
     type?: string;
 }
 /** Query parameters for `sb.transactions.credits.scheduled.list()`. */
@@ -35951,6 +35977,8 @@ interface ListInvoiceItemsQuery {
     - **paid** — fully paid
     - **voided** — cancelled and no longer valid */
     status?: string;
+    /** UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
+    invoiceRef?: string;
     /** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
     pending?: "true" | "false";
     /** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */

package/dist/index.js

@@ -953,7 +953,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items
          *
-         * List invoice items filtered by customer, location, type, status, pending, or date range. 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.
          */
         async list(query, options) {
           return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
@@ -961,7 +961,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. 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.
          */
         iterate(query, options) {
           return paginate(