@izak0s/spacebring-api 3.2.0 → 3.4.0

package/dist/index.d.cts

@@ -1959,6 +1959,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/resources/v1/assignments": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Retrieve resource assignments
+         * @description Retrieve resource assignments in the location. An assignment links a resource, or a number of seats in it, to a company or a member for the duration of a subscription. <h3>OAuth</h3>Required scopes: <code>resources.readonly</code> or <code>resources</code>
+         */
+        get: operations["getAssignments"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/resources/v1/{id}": {
         parameters: {
             query?: never;
@@ -8395,6 +8415,11 @@ interface components {
                 };
                 /** @description Assigned quantity when the resource is partially assigned. */
                 quantity?: number;
+                /**
+                 * Format: uuid
+                 * @description UUID of the resource the assignment belongs to.
+                 */
+                resourceRef: string;
                 /** @description Subscription backing this assignment. */
                 subscription: {
                     /** @description ISO timestamp when the assignment ends. */
@@ -8885,6 +8910,69 @@ interface components {
              */
             visibility: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
         };
+        getAssignments: {
+            /** @description List of resource assignments in the location. */
+            assignments: {
+                /** @description Company assigned to the resource. */
+                company?: {
+                    /**
+                     * Format: uuid
+                     * @description Company id.
+                     */
+                    id: string;
+                    /** @description Company name. */
+                    title: string;
+                };
+                /** @description Whether the assignment grants access to the entire resource. */
+                entire: boolean;
+                /**
+                 * Format: uuid
+                 * @description Assignment id.
+                 */
+                id?: string;
+                /** @description Membership linked to the assignment. */
+                membership?: {
+                    /**
+                     * Format: uuid
+                     * @description Membership id.
+                     */
+                    id: string;
+                };
+                /** @description Assigned quantity when the resource is partially assigned. */
+                quantity?: number;
+                /**
+                 * Format: uuid
+                 * @description UUID of the resource the assignment belongs to.
+                 */
+                resourceRef: string;
+                /** @description Subscription backing this assignment. */
+                subscription: {
+                    /** @description ISO timestamp when the assignment ends. */
+                    endDate?: string;
+                    /**
+                     * Format: uuid
+                     * @description Subscription id.
+                     */
+                    id: string;
+                    /** @description ISO timestamp when the assignment starts. */
+                    startDate: string;
+                };
+                /** @description User assigned to the resource. */
+                user?: {
+                    /** @description User email. */
+                    email?: string | null;
+                    /**
+                     * Format: uuid
+                     * @description User id.
+                     */
+                    id: string;
+                    /** @description User first name. */
+                    name?: string | null;
+                    /** @description User last name. */
+                    surname?: string | null;
+                };
+            }[];
+        };
         payment: {
             /** @description The amount of the payment */
             amount?: number;
@@ -11934,7 +12022,10 @@ interface components {
              * @description ID of the location.
              */
             locationRef: string;
-            /** @description Assignee membership details. */
+            /**
+             * @deprecated
+             * @description Assignee membership details. Deprecated, use userAssignee instead.
+             */
             membershipAssignee?: {
                 /**
                  * Format: uuid
@@ -11968,7 +12059,8 @@ interface components {
             };
             /**
              * Format: uuid
-             * @description ID of the assignee membership.
+             * @deprecated
+             * @description ID of the assignee membership. Deprecated, use userRefAssignee instead.
              */
             membershipRefAssignee?: string;
             /**
@@ -12050,6 +12142,11 @@ interface components {
                 /** @description Surname of the user. */
                 surname?: string | null;
             } | null;
+            /**
+             * Format: uuid
+             * @description ID of the assignee user.
+             */
+            userRefAssignee?: string;
             /** @description Requester user details. */
             userRequester?: {
                 /** @description Whether the user is blocked. */
@@ -12096,7 +12193,10 @@ interface components {
                     /** @description Image width in pixels. */
                     width?: number;
                 }[];
-                /** @description Assignee after the update. */
+                /**
+                 * @deprecated
+                 * @description Assignee after the update. Deprecated, use userAssignee instead.
+                 */
                 membershipAssignee?: {
                     /**
                      * Format: uuid
@@ -12130,7 +12230,10 @@ interface components {
                 };
                 /** @description Previous attribute values before the update. */
                 previousAttributes?: {
-                    /** @description Assignee before the update. */
+                    /**
+                     * @deprecated
+                     * @description Assignee before the update. Deprecated, use userAssignee instead.
+                     */
                     membershipAssignee?: {
                         /**
                          * Format: uuid
@@ -12167,6 +12270,31 @@ interface components {
                      * @enum {string}
                      */
                     status?: "closed" | "inProgress" | "new" | "solved";
+                    /** @description Assignee user before the update. */
+                    userAssignee?: {
+                        /** @description Whether the user is blocked. */
+                        blocked?: boolean;
+                        /** @description Email address when visible to the caller. */
+                        email?: string;
+                        /**
+                         * Format: uuid
+                         * @description Unique identifier of the user.
+                         */
+                        id: string;
+                        /** @description First name of the user. */
+                        name?: string | null;
+                        /** @description Phone number when visible to the caller. */
+                        phoneNumber?: string;
+                        /** @description Profile photo URL. */
+                        photoUrl: string | null;
+                        /** @description Surname of the user. */
+                        surname?: string | null;
+                    };
+                    /**
+                     * Format: uuid
+                     * @description ID of the assignee user before the update.
+                     */
+                    userRefAssignee?: string;
                 };
                 /**
                  * @description Status after the update.
@@ -12175,6 +12303,31 @@ interface components {
                 status?: "closed" | "inProgress" | "new" | "solved";
                 /** @description Comment text. */
                 text?: string;
+                /** @description Assignee user after the update. */
+                userAssignee?: {
+                    /** @description Whether the user is blocked. */
+                    blocked?: boolean;
+                    /** @description Email address when visible to the caller. */
+                    email?: string;
+                    /**
+                     * Format: uuid
+                     * @description Unique identifier of the user.
+                     */
+                    id: string;
+                    /** @description First name of the user. */
+                    name?: string | null;
+                    /** @description Phone number when visible to the caller. */
+                    phoneNumber?: string;
+                    /** @description Profile photo URL. */
+                    photoUrl: string | null;
+                    /** @description Surname of the user. */
+                    surname?: string | null;
+                };
+                /**
+                 * Format: uuid
+                 * @description ID of the assignee user after the update.
+                 */
+                userRefAssignee?: string;
             };
             /**
              * Format: uuid
@@ -17144,9 +17297,15 @@ interface components {
                     ticket: {
                         /**
                          * Format: uuid
-                         * @description ID of the membership to assign the ticket to, or null to unassign.
+                         * @deprecated
+                         * @description ID of the membership to assign the ticket to, or null to unassign. Deprecated, use userRefAssignee instead.
+                         */
+                        membershipRefAssignee?: string | null;
+                        /**
+                         * Format: uuid
+                         * @description ID of the user to assign the ticket to, or null to unassign.
                          */
-                        membershipRefAssignee: string | null;
+                        userRefAssignee?: string | null;
                     };
                 };
             };
@@ -22189,6 +22348,59 @@ interface operations {
             };
         };
     };
+    getAssignments: {
+        parameters: {
+            query: {
+                /** @description UUID of the location whose resource assignments to list. */
+                locationRef: 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"]["getAssignments"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+        };
+    };
     getResource: {
         parameters: {
             query?: never;
@@ -24792,10 +25004,17 @@ type UpdateProductBody = NonNullable<NonNullable<operations["updateProduct"]["re
 /** Request body for `sb.shop.categories.update()`. */
 type UpdateShopCategoryBody = NonNullable<NonNullable<operations["updateShopCategory"]["requestBody"]>["content"]["application/json"]["category"]>;
 
+/** A Assignment entity as returned by the Spacebring API. */
+type Assignment = NonNullable<operations["getAssignments"]["responses"][200]["content"]["application/json"]["assignments"]>[number];
 /** A Booking entity as returned by the Spacebring API. */
 type Booking = NonNullable<components["schemas"]["booking"]>;
 /** A Resource entity as returned by the Spacebring API. */
 type Resource = NonNullable<components["schemas"]["resource"]>;
+/** Query parameters for `sb.resources.getAssignments()`. */
+interface GetAssignmentsQuery {
+    /** UUID of the location whose resource assignments to list. */
+    locationRef: string;
+}
 /** Query parameters for `sb.resources.bookings.list()`. */
 interface GetBookingsQuery {
     /** The id of the resource. Required if `locationRef` is not passed. */
@@ -25620,6 +25839,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
         get(id: string, options?: SpacebringRequestOptions): Promise<Resource>;
         create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
         update(id: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
+        getAssignments(query: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<Assignment[]>;
         bookings: {
             list(query?: GetBookingsQuery, options?: SpacebringRequestOptions): Promise<{
                 bookings?: Booking[];
@@ -25845,4 +26065,4 @@ declare class SpacebringError extends Error {
     });
 }
 
-export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, 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 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 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 CreditTransaction, type DayPassTransaction, type Event, type EventTicket, 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 GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, 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 Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type ScheduledTransaction, 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 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 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 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 CreditTransaction, 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 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 Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type ScheduledTransaction, 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 UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };