@izak0s/spacebring-api 1.10.0 → 1.11.1

package/dist/index.d.cts

@@ -686,7 +686,11 @@ interface paths {
             path?: never;
             cookie?: never;
         };
-        get?: never;
+        /**
+         * 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>
+         */
+        get: operations["listInvoiceItems"];
         put?: never;
         /**
          * Create an invoice item
@@ -4583,6 +4587,275 @@ interface components {
              */
             transactionRef: string;
         };
+        getInvoiceItems: {
+            /** @description List of invoice items. */
+            invoiceItems: {
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use totalAmount instead.
+                 */
+                amount: number;
+                /** @description Amounts in the original base currency, before any alt-currency conversion. */
+                baseAmounts: {
+                    /** @description ISO currency code. */
+                    currencyCode: string;
+                    /** @description Discount deduction in major units. */
+                    discountedAmount: number;
+                    /** @description Tax details. */
+                    tax?: {
+                        /** @description Tax amount in major units. */
+                        amount: number;
+                        /** @description Whether tax is included in the price. */
+                        inclusive: boolean;
+                        /** @description Tax rate as a decimal. */
+                        rate: number;
+                        /** @description Amount subject to tax in major units. */
+                        taxableAmount: number;
+                    };
+                    /** @description Total in major units. */
+                    totalAmount: number;
+                    /** @description Total excluding tax in major units. */
+                    totalExcludingTaxAmount: number;
+                    /** @description Unit price in major units. */
+                    unitAmount: number;
+                    /** @description Unit price excluding tax in major units. */
+                    unitExcludingTaxAmount: number;
+                };
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use product.bookingRef instead.
+                 */
+                booking?: {
+                    [key: string]: unknown;
+                };
+                /**
+                 * Format: uuid
+                 * @description ID of the associated company.
+                 */
+                companyRef?: string;
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the item was created.
+                 */
+                createDate: string;
+                /**
+                 * @deprecated
+                 * @description Deprecated.
+                 */
+                creditPackage?: {
+                    [key: string]: unknown;
+                };
+                /** @description ISO currency code. Reflects the alt currency when present, otherwise the base currency. */
+                currencyCode: string;
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the item was deleted.
+                 */
+                deleteDate?: string;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use product.title instead.
+                 */
+                description: string;
+                /** @description Discount deduction in major units. Reflects the alt currency when present, otherwise the base currency. */
+                discountedAmount: number;
+                /** @description Applied discounts. */
+                discounts: {
+                    /** @description Coupon applied to this item. */
+                    coupon: {
+                        /** @description Fixed discount amount in major units. */
+                        amountOff?: number;
+                        /** @description Currency code for amountOff. */
+                        currencyCode?: string;
+                        /** @description Discount duration type. */
+                        duration?: string;
+                        /** @description Number of months the discount applies. */
+                        durationInMonths?: number;
+                        /**
+                         * Format: uuid
+                         * @description Coupon ID.
+                         */
+                        id?: string;
+                        /** @description Percentage discount. */
+                        percentOff?: number;
+                        /** @description Product types this coupon applies to. */
+                        productTypes?: string[];
+                        /** @description Coupon type. */
+                        type?: string;
+                    };
+                    /** @description Promocode applied to this item. */
+                    promocode?: {
+                        /** @description Promocode string. */
+                        code: string;
+                        /**
+                         * Format: date-time
+                         * @description Promocode expiration date.
+                         */
+                        expiration?: string;
+                        /**
+                         * Format: uuid
+                         * @description Promocode ID.
+                         */
+                        id: string;
+                        /** @description Whether limited to first purchase only. */
+                        limitByFirstPurchase?: boolean;
+                    };
+                    /**
+                     * Format: uuid
+                     * @description ID of the subscription this discount is associated with.
+                     */
+                    subscriptionId?: string;
+                }[];
+                /** @description Unique identifier of the invoice item. */
+                id: string;
+                /**
+                 * Format: uuid
+                 * @description ID of the invoice this item belongs to.
+                 */
+                invoiceRef?: string;
+                /**
+                 * Format: uuid
+                 * @description ID of the organization (location).
+                 */
+                locationRef: string;
+                /**
+                 * Format: uuid
+                 * @description ID of the associated membership.
+                 */
+                membershipRef?: string;
+                /**
+                 * Format: uuid
+                 * @description ID of the membership that created this item.
+                 */
+                membershipRefCreatedBy?: string;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use totalExcludingTaxAmount instead.
+                 */
+                netAmount: number;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use unitExcludingTaxAmount instead.
+                 */
+                netUnitAmount: number;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use product.orderRef instead.
+                 */
+                orderItem?: {
+                    [key: string]: unknown;
+                };
+                /** @description Billing period for subscription items. */
+                period?: {
+                    /**
+                     * Format: date-time
+                     * @description Subscription period end date.
+                     */
+                    endDate: string;
+                    /**
+                     * Format: date-time
+                     * @description Subscription period start date.
+                     */
+                    startDate: string;
+                };
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use period instead.
+                 */
+                plan?: {
+                    [key: string]: unknown;
+                };
+                /** @description Product details. */
+                product: {
+                    /**
+                     * Format: uuid
+                     * @description ID of the associated booking.
+                     */
+                    bookingRef?: string;
+                    /**
+                     * Format: uuid
+                     * @description ID of the associated event ticket.
+                     */
+                    eventTicketRef?: string;
+                    /**
+                     * Format: uuid
+                     * @description ID of the product option.
+                     */
+                    optionRef?: string;
+                    /**
+                     * Format: uuid
+                     * @description ID of the associated order.
+                     */
+                    orderRef?: string;
+                    /** @description Display title of the product. */
+                    title: string;
+                    /**
+                     * @description Type of the invoice item.
+                     * @enum {string}
+                     */
+                    type: "creditPackage" | "custom" | "booking" | "eventTicket" | "subscription" | "order";
+                };
+                /** @description Quantity of units. */
+                quantity: number;
+                /**
+                 * Format: uuid
+                 * @description ID of the associated subscription.
+                 */
+                subscriptionRef?: string;
+                /** @description Tax details. Reflects the alt currency when present, otherwise the base currency. */
+                tax?: {
+                    /** @description Tax amount in major units. */
+                    amount: number;
+                    /** @description Whether tax is included in the price. */
+                    inclusive: boolean;
+                    /** @description Tax rate as a decimal. */
+                    rate: number;
+                    /** @description Amount subject to tax in major units. */
+                    taxableAmount: number;
+                };
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use baseAmounts.tax.amount instead.
+                 */
+                taxAmount?: number;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use baseAmounts.tax.taxableAmount instead.
+                 */
+                taxableAmount?: number;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use product.eventTicketRef instead.
+                 */
+                ticket?: {
+                    [key: string]: unknown;
+                };
+                /** @description Total in major units. Reflects the alt currency when present, otherwise the base currency. */
+                totalAmount: number;
+                /** @description Total excluding tax in major units. Reflects the alt currency when present, otherwise the base currency. */
+                totalExcludingTaxAmount: number;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use product.type instead.
+                 */
+                type: string;
+                /** @description Unit price in major units. Reflects the alt currency when present, otherwise the base currency. */
+                unitAmount: number;
+                /** @description Unit price excluding tax in major units. Reflects the alt currency when present, otherwise the base currency. */
+                unitExcludingTaxAmount: number;
+                /** @description User who created this item. */
+                userCreatedBy?: {
+                    /** Format: uuid */
+                    id: string;
+                    name?: string;
+                    surname?: string;
+                };
+            }[];
+            /** @description Pagination token to fetch the next page of results. */
+            nextPageToken?: string;
+            /** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
+            searchQueryNext?: string;
+        };
         getCreditNotes: {
             /** @description List of credit notes. */
             creditNotes: {
@@ -4628,6 +4901,34 @@ interface components {
                 creditAmount?: number;
                 /** @description ISO currency code (from base or alt currency). */
                 currencyCode: string;
+                /** @description Customer associated with this credit note. */
+                customer: {
+                    /**
+                     * Format: uuid
+                     * @description ID of the company or membership.
+                     */
+                    id: string;
+                    /** @description Company logo. */
+                    logo?: {
+                        key: string;
+                        url: string;
+                    };
+                    /** @description Company name. */
+                    title?: string;
+                    /**
+                     * @description Whether the customer is a company or a user.
+                     * @enum {string}
+                     */
+                    type: "company" | "user";
+                    /** @description User details for membership customers. */
+                    user?: {
+                        /** Format: uuid */
+                        id: string;
+                        name?: string | null;
+                        photoUrl?: string | null;
+                        surname?: string | null;
+                    };
+                };
                 /** @description Effective date in YYYY-MM-DD format. */
                 effectiveDate?: string;
                 /**
@@ -4915,6 +5216,34 @@ interface components {
             creditAmount?: number;
             /** @description ISO currency code (from base or alt currency). */
             currencyCode: string;
+            /** @description Customer associated with this credit note. */
+            customer: {
+                /**
+                 * Format: uuid
+                 * @description ID of the company or membership.
+                 */
+                id: string;
+                /** @description Company logo. */
+                logo?: {
+                    key: string;
+                    url: string;
+                };
+                /** @description Company name. */
+                title?: string;
+                /**
+                 * @description Whether the customer is a company or a user.
+                 * @enum {string}
+                 */
+                type: "company" | "user";
+                /** @description User details for membership customers. */
+                user?: {
+                    /** Format: uuid */
+                    id: string;
+                    name?: string | null;
+                    photoUrl?: string | null;
+                    surname?: string | null;
+                };
+            };
             /** @description Effective date in YYYY-MM-DD format. */
             effectiveDate?: string;
             /**
@@ -5366,6 +5695,11 @@ interface components {
                  * @description ID of the location this contract belongs to.
                  */
                 locationRef: string;
+                /**
+                 * @description How the contract will be signed.
+                 * @enum {string}
+                 */
+                signatureMethod?: "eSignature" | "manual";
                 /** @description Signed document file, present after the contract is signed. */
                 signedDocument?: {
                     key: string;
@@ -5576,6 +5910,11 @@ interface components {
                  * @description ID of the location this contract belongs to.
                  */
                 locationRef: string;
+                /**
+                 * @description How the contract will be signed.
+                 * @enum {string}
+                 */
+                signatureMethod?: "eSignature" | "manual";
                 /** @description Signed document file, present after the contract is signed. */
                 signedDocument?: {
                     key: string;
@@ -7579,7 +7918,7 @@ interface components {
                 /** @description Subscription backing this assignment. */
                 subscription: {
                     /** @description ISO timestamp when the assignment ends. */
-                    endDate: string;
+                    endDate?: string;
                     /**
                      * Format: uuid
                      * @description Subscription id.
@@ -16842,6 +17181,67 @@ interface operations {
             };
         };
     };
+    listInvoiceItems: {
+        parameters: {
+            query?: {
+                /** @description Filter invoices 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. */
+                "createDate[lte]"?: string;
+                /** @description UUID of the customer whose invoices to list. */
+                customerRef?: string;
+                /** @description Filter invoices issued on or after this date (ISO 8601). 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. */
+                "issueDate[lte]"?: string;
+                /** @description Maximum number of invoices 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. */
+                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`.
+                 *
+                 *     Supported values:
+                 *     - **draft** — created but not sent
+                 *     - **issued** — sent to the customer but unpaid
+                 *     - **paid** — fully paid
+                 *     - **voided** — cancelled and no longer valid
+                 */
+                status?: string;
+                /** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
+                type?: string;
+            };
+            header?: {
+                /** @description The id of the network. Required when using bearer token authentication */
+                "spacebring-network-id"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["getInvoiceItems"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+        };
+    };
     createInvoiceItem: {
         parameters: {
             query?: never;
@@ -22707,6 +23107,35 @@ interface GetUpcomingInvoiceQuery {
     /** The id of the subscription. */
     subscriptionRef?: string;
 }
+/** 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. */
+    "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. */
+    customerRef?: string;
+    /** Filter invoices issued on or after this date (ISO 8601). 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. */
+    "issueDate[lte]"?: string;
+    /** Maximum number of invoices 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. */
+    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`.
+  
+    Supported values:
+    - **draft** — created but not sent
+    - **issued** — sent to the customer but unpaid
+    - **paid** — fully paid
+    - **voided** — cancelled and no longer valid */
+    status?: string;
+    /** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
+    type?: string;
+}
 /** Request body for `sb.billing.creditNotes.create()`. */
 type CreateCreditNoteBody = NonNullable<operations["createCreditNote"]["requestBody"]>["content"]["application/json"];
 /** Request body for `sb.billing.invoices.create()`. */
@@ -22872,6 +23301,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
             resend(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
             void(invoiceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
             items: {
+                list(query?: ListInvoiceItemsQuery, options?: SpacebringRequestOptions): Promise<{
+                    invoiceItems: InvoiceItem[];
+                    nextPageToken?: string;
+                    searchQueryNext?: string;
+                }>;
+                iterate(query?: Omit<ListInvoiceItemsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<InvoiceItem, void, undefined>;
                 get(id: string, options?: SpacebringRequestOptions): Promise<InvoiceItem>;
                 create(body: CreateInvoiceItemBody, options?: SpacebringRequestOptions): Promise<InvoiceItem>;
                 update(id: string, body: UpdateInvoiceItemBody, options?: SpacebringRequestOptions): Promise<undefined>;
@@ -23248,4 +23683,4 @@ declare class SpacebringError extends Error {
     });
 }
 
-export { type Activity, type AltCurrency, type Application, type ApplyBenefitBody, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type CommentLike, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateVisitBody, type CreditNote, type CreditTransaction, type DayPassTransaction, type Event, type EventTicket, type FeedComment, type GetAltCurrenciesQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Location, type Membership, type MoneyTransaction, type Network, type Order, type PatchGuideBody, type PatchResourceBody, type PayInvoiceBody, type Plan, type Post, type PostComment, type PostLike, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type RequestVisit, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type TerminateContractBody, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateVisitBody, type VisitorVisit, type components, type operations, type paths };
+export { type Activity, type AltCurrency, type Application, type ApplyBenefitBody, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type CommentLike, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateVisitBody, type CreditNote, type CreditTransaction, type DayPassTransaction, type Event, type EventTicket, type FeedComment, type GetAltCurrenciesQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type PatchGuideBody, type PatchResourceBody, type PayInvoiceBody, type Plan, type Post, type PostComment, type PostLike, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type RequestVisit, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type TerminateContractBody, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateVisitBody, type VisitorVisit, type components, type operations, type paths };