@izak0s/spacebring-api 9.5.0 → 9.6.0

package/dist/index.d.cts

@@ -2048,6 +2048,26 @@ interface paths {
         patch: operations["patchResource"];
         trace?: never;
     };
+    "/resources/v1/{resourceId}/availability": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Check resource availability
+         * @description Check whether a resource can be booked for a slot before creating the booking. The same rules as booking creation apply: capacity, the location and resource schedule, duration limits and the booking window. When the slot is unavailable, the response carries the code the booking would fail with. <h3>OAuth</h3>Required scopes: <code>resources.readonly</code> or <code>resources</code>
+         */
+        post: operations["getResourceAvailability"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/resources/bookings/v1": {
         parameters: {
             query?: never;
@@ -3792,7 +3812,7 @@ interface components {
                 payments: {
                     /**
                      * Format: date-time
-                     * @description ISO timestamp of the payment.
+                     * @description ISO timestamp of when the payment was recorded.
                      */
                     createDate: string;
                     /** @description Payment dispute details. */
@@ -3824,6 +3844,11 @@ interface components {
                          */
                         type: "external" | "paymentGateway";
                     };
+                    /**
+                     * Format: date-time
+                     * @description ISO timestamp of when the money was received. Absent until the payment succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it.
+                     */
+                    paymentDate?: string;
                     /** @description Payment price details. */
                     price: {
                         money: {
@@ -4189,7 +4214,7 @@ interface components {
             payments: {
                 /**
                  * Format: date-time
-                 * @description ISO timestamp of the payment.
+                 * @description ISO timestamp of when the payment was recorded.
                  */
                 createDate: string;
                 /** @description Payment dispute details. */
@@ -4221,6 +4246,11 @@ interface components {
                      */
                     type: "external" | "paymentGateway";
                 };
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the money was received. Absent until the payment succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it.
+                 */
+                paymentDate?: string;
                 /** @description Payment price details. */
                 price: {
                     money: {
@@ -4583,7 +4613,7 @@ interface components {
                 payments: {
                     /**
                      * Format: date-time
-                     * @description ISO timestamp of the payment.
+                     * @description ISO timestamp of when the payment was recorded.
                      */
                     createDate: string;
                     /** @description Payment dispute details. */
@@ -4615,6 +4645,11 @@ interface components {
                          */
                         type: "external" | "paymentGateway";
                     };
+                    /**
+                     * Format: date-time
+                     * @description ISO timestamp of when the money was received. Absent until the payment succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it.
+                     */
+                    paymentDate?: string;
                     /** @description Payment price details. */
                     price: {
                         money: {
@@ -5034,7 +5069,7 @@ interface components {
         invoicePayment: {
             /**
              * Format: date-time
-             * @description ISO timestamp of the payment.
+             * @description ISO timestamp of when the payment was recorded.
              */
             createDate: string;
             /** @description Payment dispute details. */
@@ -5066,6 +5101,11 @@ interface components {
                  */
                 type: "external" | "paymentGateway";
             };
+            /**
+             * Format: date-time
+             * @description ISO timestamp of when the money was received. Absent until the payment succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it.
+             */
+            paymentDate?: string;
             /** @description Payment price details. */
             price: {
                 money: {
@@ -7099,6 +7139,8 @@ interface components {
             checkInRef?: string;
             /** @description Six-digit code the attendee enters on the Reception app to check in. Visible to the ticket owner and admins when check-in is enabled for the event. */
             code?: string;
+            /** @description Note the attendee left when purchasing the ticket. Visible to the ticket owner and location admins only. */
+            comment?: string;
             /**
              * Format: date-time
              * @description ISO timestamp of when the ticket was created.
@@ -10338,6 +10380,17 @@ interface components {
                 };
             };
         };
+        getResourceAvailability: {
+            /** @description Whether the resource can be booked for the requested slot. */
+            available: boolean;
+            /** @description The first rule the slot breaks. Present only when available is false. */
+            reason?: {
+                /** @description The error code the booking would fail with, e.g. `bookingConflict` or `bookingScheduleConflict`. */
+                code: string;
+                /** @description The human-readable explanation of why the slot is unavailable. */
+                message: string;
+            };
+        };
         getBookings: {
             /** @description List of bookings. */
             bookings: {
@@ -11314,6 +11367,37 @@ interface components {
                 resourceRef: string;
                 /** @description Number of seats reserved. */
                 seats?: number;
+                /** @description Where the booking was created. Visible to admins only. Absent on bookings made before it was recorded. */
+                source?: {
+                    /** @description Set when `type` is `api`. */
+                    api?: {
+                        /** @description ID of the OAuth client the integration authenticated with. */
+                        clientId: string;
+                    };
+                    /** @description Set when `type` is `app`. */
+                    app?: Record<string, never>;
+                    /** @description Set when `type` is `googleCalendar`. */
+                    googleCalendar?: {
+                        /** @description ID of the Google Calendar the event was imported from. */
+                        calendarId?: string;
+                        /** @description ID of the Google Calendar event the booking mirrors. */
+                        eventId?: string;
+                        /** @description Link to the Google Calendar event. */
+                        eventLink?: string;
+                    };
+                    /** @description Set when `type` is `mcp`. */
+                    mcp?: {
+                        /** @description ID of the OAuth client the MCP client authenticated with. */
+                        clientId: string;
+                    };
+                    /** @description Set when `type` is `member`. */
+                    member?: Record<string, never>;
+                    /**
+                     * @description Where the booking was created: the admin app, the member app, an MCP client, a Google Calendar import, or a direct API integration. The matching property below carries the details.
+                     * @enum {string}
+                     */
+                    type: "api" | "app" | "googleCalendar" | "mcp" | "member";
+                };
                 /**
                  * Format: date-time
                  * @description ISO timestamp when the booking starts.
@@ -12336,6 +12420,37 @@ interface components {
                 resourceRef: string;
                 /** @description Number of seats reserved. */
                 seats?: number;
+                /** @description Where the booking was created. Visible to admins only. Absent on bookings made before it was recorded. */
+                source?: {
+                    /** @description Set when `type` is `api`. */
+                    api?: {
+                        /** @description ID of the OAuth client the integration authenticated with. */
+                        clientId: string;
+                    };
+                    /** @description Set when `type` is `app`. */
+                    app?: Record<string, never>;
+                    /** @description Set when `type` is `googleCalendar`. */
+                    googleCalendar?: {
+                        /** @description ID of the Google Calendar the event was imported from. */
+                        calendarId?: string;
+                        /** @description ID of the Google Calendar event the booking mirrors. */
+                        eventId?: string;
+                        /** @description Link to the Google Calendar event. */
+                        eventLink?: string;
+                    };
+                    /** @description Set when `type` is `mcp`. */
+                    mcp?: {
+                        /** @description ID of the OAuth client the MCP client authenticated with. */
+                        clientId: string;
+                    };
+                    /** @description Set when `type` is `member`. */
+                    member?: Record<string, never>;
+                    /**
+                     * @description Where the booking was created: the admin app, the member app, an MCP client, a Google Calendar import, or a direct API integration. The matching property below carries the details.
+                     * @enum {string}
+                     */
+                    type: "api" | "app" | "googleCalendar" | "mcp" | "member";
+                };
                 /**
                  * Format: date-time
                  * @description ISO timestamp when the booking starts.
@@ -18929,6 +19044,11 @@ interface components {
                     /** @description Payment gateway identifier, or external. */
                     type: string;
                 };
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the money was received. Absent until the transaction succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it. Ordering and the createDate filters always follow createDate, not this field.
+                 */
+                paymentDate?: string;
                 /**
                  * @deprecated
                  * @description Deprecated. Use product instead.
@@ -19636,6 +19756,11 @@ interface components {
                     /** @description Payment gateway identifier, or external. */
                     type: string;
                 };
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the money was received. Absent until the transaction succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it. Ordering and the createDate filters always follow createDate, not this field.
+                 */
+                paymentDate?: string;
                 /**
                  * @deprecated
                  * @description Deprecated. Use product instead.
@@ -20343,6 +20468,11 @@ interface components {
                     /** @description Payment gateway identifier, or external. */
                     type: string;
                 };
+                /**
+                 * Format: date-time
+                 * @description ISO timestamp of when the money was received. Absent until the transaction succeeds. A payment gateway sets it when it approves the payment; an external payment takes the date the administrator recorded, defaulting to when they recorded it. Ordering and the createDate filters always follow createDate, not this field.
+                 */
+                paymentDate?: string;
                 /**
                  * @deprecated
                  * @description Deprecated. Use product instead.
@@ -21254,7 +21384,13 @@ interface components {
                         /** @description Payment method details. */
                         method: {
                             /** @description External payment method, recorded outside the platform. */
-                            external?: Record<string, never>;
+                            external?: {
+                                /**
+                                 * Format: date-time
+                                 * @description ISO timestamp of when the money was received. Defaults to now. Must not be in the future.
+                                 */
+                                paymentDate?: string;
+                            };
                             /** @description Payment gateway (card) payment method. */
                             paymentGateway?: {
                                 /**
@@ -23462,6 +23598,28 @@ interface components {
                 };
             };
         };
+        getResourceAvailability: {
+            content: {
+                "application/json": {
+                    /**
+                     * Format: date-time
+                     * @description The end of the slot to check, in ISO 8601.
+                     */
+                    endDate: string;
+                    /** @description Set to true to check the entire resource instead of individual seats. Supported for office resources. */
+                    entire?: boolean;
+                    /** @description The number of seats to check. Required for seat-based resources such as hot desks, unless entire is true. */
+                    quantity?: number;
+                    /** @description RRULE lines describing a repeating slot, e.g. `RRULE:FREQ=WEEKLY;COUNT=10`. The DTSTART line is derived from startDate. The slot is unavailable as soon as any occurrence is. */
+                    recurrence?: string[];
+                    /**
+                     * Format: date-time
+                     * @description The start of the slot to check, in ISO 8601.
+                     */
+                    startDate: string;
+                };
+            };
+        };
         createBooking: {
             content: {
                 "application/json": {
@@ -24881,7 +25039,13 @@ interface components {
                         /** @description Payment method details. */
                         method: {
                             /** @description External payment method, recorded outside the platform. */
-                            external?: Record<string, never>;
+                            external?: {
+                                /**
+                                 * Format: date-time
+                                 * @description ISO timestamp of when the money was received. Defaults to now. Must not be in the future.
+                                 */
+                                paymentDate?: string;
+                            };
                             /** @description Payment gateway (card) payment method. */
                             paymentGateway?: {
                                 /**
@@ -30149,6 +30313,41 @@ interface operations {
             };
         };
     };
+    getResourceAvailability: {
+        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 the resource. */
+                resourceId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: components["requestBodies"]["getResourceAvailability"];
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["getResourceAvailability"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+        };
+    };
     getBookings: {
         parameters: {
             query?: {
@@ -32941,6 +33140,8 @@ type UpdateShopCategoryBody = NonNullable<NonNullable<operations["updateShopCate
 type Assignment = NonNullable<operations["getAssignments"]["responses"][200]["content"]["application/json"]["assignments"]>[number];
 /** A Booking entity as returned by the Spacebring API. */
 type Booking = NonNullable<operations["getBooking"]["responses"][200]["content"]["application/json"]["booking"]>;
+/** A GetResourceAvailability entity as returned by the Spacebring API. */
+type GetResourceAvailability = NonNullable<components["schemas"]["getResourceAvailability"]>;
 /** A Resource entity as returned by the Spacebring API. */
 type Resource = NonNullable<operations["getResource"]["responses"][200]["content"]["application/json"]["resource"]>;
 /** Query parameters for `sb.resources.assignments.list()`. */
@@ -33024,6 +33225,8 @@ type CreateAssignmentBody = NonNullable<NonNullable<operations["createAssignment
 type CreateBookingBody = NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"];
 /** Request body for `sb.resources.create()`. */
 type CreateResourceBody = NonNullable<NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"]["resource"]>;
+/** Request body for `sb.resources.getResourceAvailability()`. */
+type GetResourceAvailabilityBody = NonNullable<operations["getResourceAvailability"]["requestBody"]>["content"]["application/json"];
 /** Request body for `sb.resources.assignments.update()`. */
 type PatchAssignmentBody = NonNullable<NonNullable<operations["patchAssignment"]["requestBody"]>["content"]["application/json"]["assignment"]>;
 /** Request body for `sb.resources.bookings.update()`. */
@@ -33827,6 +34030,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
         get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
         create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
         update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
+        getResourceAvailability(resourceId: string, body: GetResourceAvailabilityBody, options?: SpacebringRequestOptions): Promise<GetResourceAvailability>;
         assignments: {
             list(query?: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<{
                 assignments: Assignment[];
@@ -34079,4 +34283,4 @@ declare class SpacebringError extends Error {
     });
 }
 
-export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateAssignmentBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateEventMediaBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreateMoneyTransactionBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, 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 GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Media, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchAssignmentBody, type PatchBookingBody, type PatchGuideBody, type PatchMoneyTransactionBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Refund, type RefundMoneyTransactionBody, type Registration, type Request$1 as Request, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TerminateContractBody, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketCommentBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };
+export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateAssignmentBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateEventMediaBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreateMoneyTransactionBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, 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 GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourceAvailability, type GetResourceAvailabilityBody, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Media, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchAssignmentBody, type PatchBookingBody, type PatchGuideBody, type PatchMoneyTransactionBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Refund, type RefundMoneyTransactionBody, type Registration, type Request$1 as Request, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TerminateContractBody, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketCommentBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };