npm - @izak0s/spacebring-api - Versions diffs - 10.5.0 → 10.6.0 - Mend

@izak0s/spacebring-api 10.5.0 → 10.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/dist/index.d.cts CHANGED Viewed

@@ -708,7 +708,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @description List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -9888,6 +9888,18 @@ interface components {
                  * @enum {string}
                  */
                 bookingUnit: "hour" | "day";
+                /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
+                bookingWindow: {
+                    /**
+                     * @description How far ahead users can book the resource.
+                     * @enum {string}
+                     */
+                    bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                    /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                    enabled: boolean;
+                    /** @description How many minutes before it starts a booking of the resource has to be made. */
+                    minNotice?: number;
+                };
                 /** @description Brivo access group reference. */
                 brivoGroupRef?: number | null;
                 /**
@@ -10519,6 +10531,18 @@ interface components {
                  * @enum {string}
                  */
                 bookingUnit: "hour" | "day";
+                /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
+                bookingWindow: {
+                    /**
+                     * @description How far ahead users can book the resource.
+                     * @enum {string}
+                     */
+                    bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                    /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                    enabled: boolean;
+                    /** @description How many minutes before it starts a booking of the resource has to be made. */
+                    minNotice?: number;
+                };
                 /** @description Brivo access group reference. */
                 brivoGroupRef?: number | null;
                 /**
@@ -11844,6 +11868,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 };
@@ -12269,6 +12298,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 }[];
@@ -12906,6 +12940,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 };
@@ -13331,6 +13370,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 }[];
@@ -24192,6 +24236,18 @@ interface components {
                          * @enum {string}
                          */
                         bookingUnit?: "hour" | "day";
+                        /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
+                        bookingWindow?: {
+                            /**
+                             * @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
+                             * @enum {string}
+                             */
+                            bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                            /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                            enabled: boolean;
+                            /** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
+                            minNotice?: number;
+                        };
                         /** @description Brivo access group reference. */
                         brivoGroupRef?: number | null;
                         /**
@@ -24629,6 +24685,18 @@ interface components {
                          * @enum {string}
                          */
                         bookingUnit?: "hour" | "day";
+                        /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
+                        bookingWindow?: {
+                            /**
+                             * @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
+                             * @enum {string}
+                             */
+                            bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                            /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                            enabled: boolean;
+                            /** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
+                            minNotice?: number;
+                        };
                         /** @description Brivo access group reference. */
                         brivoGroupRef?: number | null;
                         /**
@@ -27741,6 +27809,8 @@ interface operations {
                  *     - **voided** — cancelled and no longer valid
                  */
                 status?: 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`. */
                 type?: string;
             };
@@ -35732,6 +35802,8 @@ interface ListInvoiceItemsQuery {
     - **paid** — fully paid
     - **voided** — cancelled and no longer valid */
     status?: 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`. */
     type?: string;
 }

package/dist/index.d.ts CHANGED Viewed

@@ -708,7 +708,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @description List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @description 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. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -9888,6 +9888,18 @@ interface components {
                  * @enum {string}
                  */
                 bookingUnit: "hour" | "day";
+                /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
+                bookingWindow: {
+                    /**
+                     * @description How far ahead users can book the resource.
+                     * @enum {string}
+                     */
+                    bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                    /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                    enabled: boolean;
+                    /** @description How many minutes before it starts a booking of the resource has to be made. */
+                    minNotice?: number;
+                };
                 /** @description Brivo access group reference. */
                 brivoGroupRef?: number | null;
                 /**
@@ -10519,6 +10531,18 @@ interface components {
                  * @enum {string}
                  */
                 bookingUnit: "hour" | "day";
+                /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
+                bookingWindow: {
+                    /**
+                     * @description How far ahead users can book the resource.
+                     * @enum {string}
+                     */
+                    bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                    /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                    enabled: boolean;
+                    /** @description How many minutes before it starts a booking of the resource has to be made. */
+                    minNotice?: number;
+                };
                 /** @description Brivo access group reference. */
                 brivoGroupRef?: number | null;
                 /**
@@ -11844,6 +11868,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 };
@@ -12269,6 +12298,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 }[];
@@ -12906,6 +12940,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 };
@@ -13331,6 +13370,11 @@ interface components {
                     };
                     /** @description ID of the transaction the payment was recorded as. */
                     transactionRef?: string;
+                    /**
+                     * @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
+                     * @enum {string}
+                     */
+                    transactionType?: "charge" | "refund";
                     /** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
                     type?: string;
                 }[];
@@ -24192,6 +24236,18 @@ interface components {
                          * @enum {string}
                          */
                         bookingUnit?: "hour" | "day";
+                        /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
+                        bookingWindow?: {
+                            /**
+                             * @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
+                             * @enum {string}
+                             */
+                            bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                            /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                            enabled: boolean;
+                            /** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
+                            minNotice?: number;
+                        };
                         /** @description Brivo access group reference. */
                         brivoGroupRef?: number | null;
                         /**
@@ -24629,6 +24685,18 @@ interface components {
                          * @enum {string}
                          */
                         bookingUnit?: "hour" | "day";
+                        /** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
+                        bookingWindow?: {
+                            /**
+                             * @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
+                             * @enum {string}
+                             */
+                            bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
+                            /** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
+                            enabled: boolean;
+                            /** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
+                            minNotice?: number;
+                        };
                         /** @description Brivo access group reference. */
                         brivoGroupRef?: number | null;
                         /**
@@ -27741,6 +27809,8 @@ interface operations {
                  *     - **voided** — cancelled and no longer valid
                  */
                 status?: 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`. */
                 type?: string;
             };
@@ -35732,6 +35802,8 @@ interface ListInvoiceItemsQuery {
     - **paid** — fully paid
     - **voided** — cancelled and no longer valid */
     status?: 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`. */
     type?: string;
 }

package/dist/index.js CHANGED Viewed

@@ -964,7 +964,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items
          *
-         * List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice.
+         * 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.
          */
         async list(query, options) {
           return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
@@ -972,7 +972,7 @@ function createBilling(client, defaults) {
         /**
          * List invoice items — iterates every item across all pages.
          *
-         * List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice.
+         * 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.
          */
         iterate(query, options) {
           return paginate(