@izak0s/spacebring-api 10.6.0 → 11.0.0

package/dist/index.d.ts

@@ -619,26 +619,6 @@ interface paths {
         patch?: never;
         trace?: never;
     };
-    "/billing/invoices/v1/{invoiceId}/items": {
-        parameters: {
-            query?: never;
-            header?: never;
-            path?: never;
-            cookie?: never;
-        };
-        /**
-         * List invoice items
-         * @description List all items for a specific invoice. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
-         */
-        get: operations["getInvoiceItems"];
-        put?: never;
-        post?: never;
-        delete?: never;
-        options?: never;
-        head?: never;
-        patch?: never;
-        trace?: never;
-    };
     "/billing/invoices/v1/{invoiceId}/pay": {
         parameters: {
             query?: never;
@@ -708,7 +688,7 @@ interface paths {
         };
         /**
          * List invoice items
-         * @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>
+         * @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>
          */
         get: operations["listInvoiceItems"];
         put?: never;
@@ -760,7 +740,8 @@ interface paths {
         };
         /**
          * List upcoming invoice items
-         * @description List upcoming invoice items. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
+         * @deprecated
+         * @description List a customer's pending invoice items. Deprecated: use <a href="/developer/api/billing/list-invoice-items">List invoice items</a> with <code>pending=true</code> and <code>customerRef</code> instead. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
          */
         get: operations["getUpcomingInvoiceItems"];
         put?: never;
@@ -5269,6 +5250,11 @@ interface components {
              * @description ID of the invoice this item belongs to.
              */
             invoiceRef?: string;
+            /**
+             * Format: date-time
+             * @description ISO timestamp of when the item was issued with its invoice.
+             */
+            issueDate?: string;
             /**
              * Format: uuid
              * @description ID of the organization (location).
@@ -5665,6 +5651,11 @@ interface components {
                  * @description ID of the invoice this item belongs to.
                  */
                 invoiceRef?: string;
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the item was issued with its invoice.
+                 */
+                issueDate?: string;
                 /**
                  * Format: uuid
                  * @description ID of the organization (location).
@@ -8920,7 +8911,7 @@ interface components {
             legalName?: string;
             /** @enum {string} */
             locale?: "en" | "es" | "ko" | "uk" | "ru";
-            /** @description Images of the location, newest first. */
+            /** @description Photos and videos of the location in the order administrators arranged them, with any added since first, newest first. The first one is the location's cover. */
             media?: {
                 height?: number;
                 /** @description Storage key of the image. */
@@ -10278,6 +10269,60 @@ interface components {
                  * @enum {string}
                  */
                 preparationMinutes: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
+                /** @description Prices that replace the regular money and credit tiers for bookings starting on the selected weekdays. A booking is priced by the rule covering the weekday of its start in the location's time zone, and by the regular tiers when no rule covers it. */
+                pricingRules: {
+                    /** @description Credit prices on the selected days. When omitted, the regular credit tiers apply on them. */
+                    credits?: {
+                        /** @description Stepped credit pricing tiers for the selected days. */
+                        tiers: {
+                            /** @description Fixed fee added once to bookings in this tier. */
+                            flatAmount: number;
+                            /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                            from: number;
+                            /**
+                             * @description Whether the tier is priced per hour or per day.
+                             * @enum {string}
+                             */
+                            unit: "hour" | "day";
+                            /** @description Price per unit of booking time within this tier, never per minute. */
+                            unitAmount: number;
+                        }[];
+                    };
+                    /** @description Weekdays, in the location's time zone, on which a booking that starts gets these prices. */
+                    days: {
+                        /** @description Whether the rule applies to bookings starting on a Friday. */
+                        friday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Monday. */
+                        monday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Saturday. */
+                        saturday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Sunday. */
+                        sunday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Thursday. */
+                        thursday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Tuesday. */
+                        tuesday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Wednesday. */
+                        wednesday: boolean;
+                    };
+                    /** @description Money prices on the selected days. When omitted, the regular money tiers apply on them. */
+                    money?: {
+                        /** @description Stepped money pricing tiers for the selected days. */
+                        tiers: {
+                            /** @description Fixed fee added once to bookings in this tier. */
+                            flatAmount: number;
+                            /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                            from: number;
+                            /**
+                             * @description Whether the tier is priced per hour or per day.
+                             * @enum {string}
+                             */
+                            unit: "hour" | "day";
+                            /** @description Price per unit of booking time within this tier, never per minute. */
+                            unitAmount: number;
+                        }[];
+                    };
+                }[];
                 /**
                  * @description Refund threshold for cancellations.
                  * @enum {string}
@@ -10921,6 +10966,60 @@ interface components {
                  * @enum {string}
                  */
                 preparationMinutes: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
+                /** @description Prices that replace the regular money and credit tiers for bookings starting on the selected weekdays. A booking is priced by the rule covering the weekday of its start in the location's time zone, and by the regular tiers when no rule covers it. */
+                pricingRules: {
+                    /** @description Credit prices on the selected days. When omitted, the regular credit tiers apply on them. */
+                    credits?: {
+                        /** @description Stepped credit pricing tiers for the selected days. */
+                        tiers: {
+                            /** @description Fixed fee added once to bookings in this tier. */
+                            flatAmount: number;
+                            /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                            from: number;
+                            /**
+                             * @description Whether the tier is priced per hour or per day.
+                             * @enum {string}
+                             */
+                            unit: "hour" | "day";
+                            /** @description Price per unit of booking time within this tier, never per minute. */
+                            unitAmount: number;
+                        }[];
+                    };
+                    /** @description Weekdays, in the location's time zone, on which a booking that starts gets these prices. */
+                    days: {
+                        /** @description Whether the rule applies to bookings starting on a Friday. */
+                        friday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Monday. */
+                        monday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Saturday. */
+                        saturday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Sunday. */
+                        sunday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Thursday. */
+                        thursday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Tuesday. */
+                        tuesday: boolean;
+                        /** @description Whether the rule applies to bookings starting on a Wednesday. */
+                        wednesday: boolean;
+                    };
+                    /** @description Money prices on the selected days. When omitted, the regular money tiers apply on them. */
+                    money?: {
+                        /** @description Stepped money pricing tiers for the selected days. */
+                        tiers: {
+                            /** @description Fixed fee added once to bookings in this tier. */
+                            flatAmount: number;
+                            /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                            from: number;
+                            /**
+                             * @description Whether the tier is priced per hour or per day.
+                             * @enum {string}
+                             */
+                            unit: "hour" | "day";
+                            /** @description Price per unit of booking time within this tier, never per minute. */
+                            unitAmount: number;
+                        }[];
+                    };
+                }[];
                 /**
                  * @description Refund threshold for cancellations.
                  * @enum {string}
@@ -24477,6 +24576,50 @@ interface components {
                          * @enum {string}
                          */
                         preparationMinutes?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
+                        /** @description Prices that replace the regular money and credit tiers for bookings starting on the selected weekdays. The list holds at most one rule. On update the list replaces the current rule, and an empty list removes it. */
+                        pricingRules?: {
+                            /** @description Credit prices on the selected days, kept only while credits are enabled. Omit to keep the regular credit tiers on them. */
+                            credits?: {
+                                /** @description Stepped credit pricing tiers for the selected days. */
+                                tiers: {
+                                    /** @description Fixed fee added once to bookings in this tier. */
+                                    flatAmount: number;
+                                    /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                                    from: number;
+                                    /** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
+                                    unitAmount: number;
+                                }[];
+                            };
+                            /** @description Weekdays, in the location's time zone, on which a booking that starts gets these prices. Select at least one day. */
+                            days: {
+                                /** @description Whether the rule applies to bookings starting on a Friday. */
+                                friday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Monday. */
+                                monday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Saturday. */
+                                saturday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Sunday. */
+                                sunday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Thursday. */
+                                thursday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Tuesday. */
+                                tuesday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Wednesday. */
+                                wednesday: boolean;
+                            };
+                            /** @description Money prices on the selected days, kept only while money is enabled. Omit to keep the regular money tiers on them. */
+                            money?: {
+                                /** @description Stepped money pricing tiers for the selected days. */
+                                tiers: {
+                                    /** @description Fixed fee added once to bookings in this tier. */
+                                    flatAmount: number;
+                                    /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                                    from: number;
+                                    /** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
+                                    unitAmount: number;
+                                }[];
+                            };
+                        }[];
                         /**
                          * @description How long before start a booking remains refundable.
                          * @enum {string}
@@ -24916,6 +25059,50 @@ interface components {
                          * @enum {string}
                          */
                         preparationMinutes?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
+                        /** @description Prices that replace the regular money and credit tiers for bookings starting on the selected weekdays. The list holds at most one rule. On update the list replaces the current rule, and an empty list removes it. */
+                        pricingRules?: {
+                            /** @description Credit prices on the selected days, kept only while credits are enabled. Omit to keep the regular credit tiers on them. */
+                            credits?: {
+                                /** @description Stepped credit pricing tiers for the selected days. */
+                                tiers: {
+                                    /** @description Fixed fee added once to bookings in this tier. */
+                                    flatAmount: number;
+                                    /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                                    from: number;
+                                    /** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
+                                    unitAmount: number;
+                                }[];
+                            };
+                            /** @description Weekdays, in the location's time zone, on which a booking that starts gets these prices. Select at least one day. */
+                            days: {
+                                /** @description Whether the rule applies to bookings starting on a Friday. */
+                                friday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Monday. */
+                                monday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Saturday. */
+                                saturday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Sunday. */
+                                sunday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Thursday. */
+                                thursday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Tuesday. */
+                                tuesday: boolean;
+                                /** @description Whether the rule applies to bookings starting on a Wednesday. */
+                                wednesday: boolean;
+                            };
+                            /** @description Money prices on the selected days, kept only while money is enabled. Omit to keep the regular money tiers on them. */
+                            money?: {
+                                /** @description Stepped money pricing tiers for the selected days. */
+                                tiers: {
+                                    /** @description Fixed fee added once to bookings in this tier. */
+                                    flatAmount: number;
+                                    /** @description Booking length in minutes at which this tier starts, for example 480 for 8 hours. */
+                                    from: number;
+                                    /** @description Price per hour of booking within this tier, not per minute, for example 40 for 40 per hour. */
+                                    unitAmount: number;
+                                }[];
+                            };
+                        }[];
                         /**
                          * @description How long before start a booking remains refundable.
                          * @enum {string}
@@ -27638,44 +27825,6 @@ interface operations {
             };
         };
     };
-    getInvoiceItems: {
-        parameters: {
-            query?: never;
-            header?: {
-                /** @description The id of the network. Required when using bearer token authentication */
-                "spacebring-network-id"?: string;
-            };
-            path: {
-                /** @description The id of an invoice. */
-                invoiceId: string;
-            };
-            cookie?: never;
-        };
-        requestBody?: never;
-        responses: {
-            /** @description OK */
-            200: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": {
-                        invoice?: components["schemas"]["invoice"];
-                        invoiceItems?: components["schemas"]["invoiceItem"][];
-                    };
-                };
-            };
-            /** @description Bad Request */
-            400: {
-                headers: {
-                    [name: string]: unknown;
-                };
-                content: {
-                    "application/json": components["schemas"]["responseError"];
-                };
-            };
-        };
-    };
     payInvoice: {
         parameters: {
             query?: never;
@@ -27783,24 +27932,24 @@ interface operations {
     listInvoiceItems: {
         parameters: {
             query?: {
-                /** @description Filter invoices created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
+                /** @description Filter invoice items created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
                 "createDate[gte]"?: string;
-                /** @description Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
+                /** @description Filter invoice items 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 invoice items to list. */
                 customerRef?: string;
-                /** @description Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
+                /** @description Filter invoice items on invoices issued on or after this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[lte] for a range. */
                 "issueDate[gte]"?: string;
-                /** @description Filter invoices issued on or before this date (ISO 8601). Use with issueDate[gte] for a range. */
+                /** @description Filter invoice items on invoices issued on or before this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[gte] for a range. */
                 "issueDate[lte]"?: string;
-                /** @description Maximum number of invoices per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
+                /** @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 invoices to list. */
+                /** @description UUID of the location whose invoice items to list. */
                 locationRef?: string;
                 /** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
                 nextPageToken?: string;
                 /**
-                 * @description Filter by invoice status. Comma-separated values, e.g. `draft,issued`.
+                 * @description Filter by the status of the invoice the item is on. Items not on an invoice are excluded. Comma-separated values, e.g. `draft,issued`.
                  *
                  *     Supported values:
                  *     - **draft** — created but not sent
@@ -35778,23 +35927,23 @@ interface GetUpcomingInvoiceQuery {
 }
 /** Query parameters for `sb.billing.invoices.items.list()`. */
 interface ListInvoiceItemsQuery {
-    /** Filter invoices created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
+    /** Filter invoice items created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
     "createDate[gte]"?: string;
-    /** Filter invoices created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
+    /** Filter invoice items 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 invoice items to list. */
     customerRef?: string;
-    /** Filter invoices issued on or after this date (ISO 8601). Use with issueDate[lte] for a range. */
+    /** Filter invoice items on invoices issued on or after this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[lte] for a range. */
     "issueDate[gte]"?: string;
-    /** Filter invoices issued on or before this date (ISO 8601). Use with issueDate[gte] for a range. */
+    /** Filter invoice items on invoices issued on or before this date (ISO 8601). Items not on an issued invoice are excluded. Use with issueDate[gte] for a range. */
     "issueDate[lte]"?: string;
-    /** Maximum number of invoices per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
+    /** 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 invoices to list. */
+    /** UUID of the location whose invoice items to list. */
     locationRef?: string;
     /** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
     nextPageToken?: string;
-    /** Filter by invoice status. Comma-separated values, e.g. `draft,issued`.
+    /** Filter by the status of the invoice the item is on. Items not on an invoice are excluded. Comma-separated values, e.g. `draft,issued`.
   
     Supported values:
     - **draft** — created but not sent
@@ -35970,10 +36119,6 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
             delete(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
             cancelPayment(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
             duplicate(invoiceId: string, options?: SpacebringRequestOptions): Promise<Invoice>;
-            getItems(invoiceId: string, options?: SpacebringRequestOptions): Promise<{
-                invoice?: Invoice;
-                invoiceItems?: InvoiceItem[];
-            }>;
             getUpcoming(query?: GetUpcomingInvoiceQuery, options?: SpacebringRequestOptions): Promise<{
                 invoice?: Invoice;
                 invoiceItems?: InvoiceItem[];

package/dist/index.js

@@ -895,17 +895,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
        *
@@ -964,7 +953,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, 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.
          */
         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 +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. 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, 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.
          */
         iterate(query, options) {
           return paginate(
@@ -1022,7 +1011,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");
         }