@izak0s/spacebring-api 7.1.0 → 8.0.0

package/dist/index.d.cts

@@ -1972,13 +1972,37 @@ interface paths {
          */
         get: operations["getAssignments"];
         put?: never;
-        post?: never;
+        /**
+         * Create a resource assignment
+         * @description Create a resource assignment. An assignment links a resource, or a number of seats in it, to a company or a member. <h3>OAuth</h3>Required scopes: <code>resources</code>
+         */
+        post: operations["createAssignment"];
         delete?: never;
         options?: never;
         head?: never;
         patch?: never;
         trace?: never;
     };
+    "/resources/v1/assignments/{assignmentId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        /**
+         * Update a resource assignment
+         * @description Update a resource assignment. Fields left out of the request keep their current value. <h3>OAuth</h3>Required scopes: <code>resources</code>
+         */
+        patch: operations["patchAssignment"];
+        trace?: never;
+    };
     "/resources/v1/{resourceId}": {
         parameters: {
             query?: never;
@@ -9955,6 +9979,130 @@ interface components {
                 };
             }[];
         };
+        createAssignment: {
+            /** @description The created assignment. */
+            assignment: {
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use customer instead. Company assigned to the resource.
+                 */
+                company?: {
+                    /**
+                     * Format: uuid
+                     * @description Company id.
+                     */
+                    id: string;
+                    /** @description Company name. */
+                    title: string;
+                };
+                /** @description Customer the resource is assigned to. */
+                customer?: {
+                    /**
+                     * Format: uuid
+                     * @description Customer id.
+                     */
+                    id: string;
+                    /** @description Company name when the customer is a company. */
+                    title?: string;
+                    /**
+                     * @description Whether the customer is a user or company.
+                     * @enum {string}
+                     */
+                    type: "user" | "company";
+                    /** @description User details when the customer is a user. */
+                    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;
+                    };
+                };
+                /** @description ISO timestamp when the assignment ends. */
+                endDate?: string;
+                /** @description Whether the assignment grants access to the entire resource. */
+                entire: boolean;
+                /**
+                 * Format: uuid
+                 * @description Assignment id.
+                 */
+                id?: string;
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use customer instead. Membership linked to the assignment.
+                 */
+                membership?: {
+                    /**
+                     * Format: uuid
+                     * @description Membership id.
+                     */
+                    id: string;
+                };
+                /** @description Assigned quantity when the resource is partially assigned. */
+                quantity?: number;
+                /** @description Resource the assignment belongs to. Present when assignments are listed on their own. */
+                resource?: {
+                    /**
+                     * Format: uuid
+                     * @description Resource id.
+                     */
+                    id: string;
+                    /** @description Resource image URL. */
+                    imageUrl?: string;
+                    /**
+                     * Format: uuid
+                     * @description UUID of the location the resource belongs to.
+                     */
+                    locationRef: string;
+                    /** @description Resource title. */
+                    title: string;
+                    /** @description Resource type. */
+                    type: string;
+                };
+                /**
+                 * Format: uuid
+                 * @description UUID of the resource the assignment belongs to.
+                 */
+                resourceRef: string;
+                /** @description ISO timestamp when the assignment starts. */
+                startDate: string;
+                /** @description Deprecated. Use startDate and endDate instead. Subscription backing this assignment. */
+                subscription: {
+                    /** @description ISO timestamp when the assignment ends. */
+                    endDate?: string;
+                    /**
+                     * Format: uuid
+                     * @description Subscription id. Absent for assignments created directly by an admin.
+                     */
+                    id?: string;
+                    /** @description ISO timestamp when the assignment starts. */
+                    startDate: string;
+                };
+                /**
+                 * @deprecated
+                 * @description Deprecated. Use customer instead. 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;
+                };
+            };
+        };
         getBookings: {
             /** @description List of bookings. */
             bookings: {
@@ -10019,7 +10167,7 @@ interface components {
                  * @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
                  */
                 membershipRefOwner?: string;
-                /** @description Internal note. Visible to admins only. */
+                /** @description Note attached to the booking. Visible to the booking owner and to admins. */
                 memo?: string;
                 /**
                  * @deprecated
@@ -10991,7 +11139,7 @@ interface components {
                  * @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
                  */
                 membershipRefOwner?: string;
-                /** @description Internal note. Visible to admins only. */
+                /** @description Note attached to the booking. Visible to the booking owner and to admins. */
                 memo?: string;
                 /**
                  * @deprecated
@@ -15623,7 +15771,7 @@ interface components {
                 resolveDate?: string;
                 /**
                  * Format: date-time
-                 * @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into.
+                 * @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into. Once a charge has been deferred it is the latest date the transaction can still be charged before the booking is canceled.
                  */
                 scheduleDate: string;
                 /** @description Transaction status. */
@@ -17049,7 +17197,7 @@ interface components {
                 resolveDate?: string;
                 /**
                  * Format: date-time
-                 * @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into.
+                 * @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into. Once a charge has been deferred it is the latest date the transaction can still be charged before the booking is canceled.
                  */
                 scheduleDate: string;
                 /** @description Transaction status. */
@@ -20448,6 +20596,65 @@ interface components {
                 };
             };
         };
+        createAssignment: {
+            content: {
+                "application/json": {
+                    assignment: {
+                        /**
+                         * Format: uuid
+                         * @description UUID of the company or user membership the resource is assigned to. Omit to hold the resource without a customer.
+                         */
+                        customerRef?: string;
+                        /**
+                         * Format: date-time
+                         * @description ISO timestamp when the assignment ends. Omit for an open-ended assignment.
+                         */
+                        endDate?: string;
+                        /** @description Whether the assignment grants access to the entire resource. */
+                        entire: boolean;
+                        /** @description Assigned quantity when the resource is partially assigned. Required when entire is false, not allowed otherwise. */
+                        quantity?: number;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the resource to assign.
+                         */
+                        resourceRef: string;
+                        /**
+                         * Format: date-time
+                         * @description ISO timestamp when the assignment starts.
+                         */
+                        startDate: string;
+                    };
+                };
+            };
+        };
+        patchAssignment: {
+            content: {
+                "application/json": {
+                    assignment: {
+                        /**
+                         * Format: date-time
+                         * @description ISO timestamp when the assignment ends. Send null to make the assignment open-ended.
+                         */
+                        endDate?: string | null;
+                        /** @description Whether the assignment grants access to the entire resource. */
+                        entire?: boolean;
+                        /** @description Assigned quantity when the resource is partially assigned. Required when entire is false, not allowed otherwise. */
+                        quantity?: number;
+                        /**
+                         * Format: uuid
+                         * @description UUID of the resource to assign.
+                         */
+                        resourceRef?: string;
+                        /**
+                         * Format: date-time
+                         * @description ISO timestamp when the assignment starts.
+                         */
+                        startDate?: string;
+                    };
+                };
+            };
+        };
         patchResource: {
             content: {
                 "application/json": {
@@ -27080,6 +27287,107 @@ interface operations {
             };
         };
     };
+    createAssignment: {
+        parameters: {
+            query?: never;
+            header?: {
+                /** @description The id of the network. Required when using bearer token authentication */
+                "spacebring-network-id"?: string;
+            };
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: components["requestBodies"]["createAssignment"];
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["createAssignment"];
+                };
+            };
+            /** @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"];
+                };
+            };
+        };
+    };
+    patchAssignment: {
+        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 assignment. */
+                assignmentId: string;
+            };
+            cookie?: never;
+        };
+        requestBody: components["requestBodies"]["patchAssignment"];
+        responses: {
+            /** @description No Content */
+            204: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
+            };
+            /** @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;
@@ -29800,7 +30108,7 @@ type Assignment = NonNullable<operations["getAssignments"]["responses"][200]["co
 type Booking = NonNullable<operations["getBooking"]["responses"][200]["content"]["application/json"]["booking"]>;
 /** 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.getAssignments()`. */
+/** Query parameters for `sb.resources.assignments.list()`. */
 interface GetAssignmentsQuery {
     /** UUID of the location whose resource assignments to list. */
     locationRef?: string;
@@ -29863,10 +30171,14 @@ interface GetResourcesQuery {
     /** Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. Defaults to all bookable types. */
     types?: string;
 }
+/** Request body for `sb.resources.assignments.create()`. */
+type CreateAssignmentBody = NonNullable<NonNullable<operations["createAssignment"]["requestBody"]>["content"]["application/json"]["assignment"]>;
 /** Request body for `sb.resources.bookings.create()`. */
 type CreateBookingBody = NonNullable<NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"]["booking"]>;
 /** Request body for `sb.resources.create()`. */
 type CreateResourceBody = NonNullable<NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"]["resource"]>;
+/** 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()`. */
 type PatchBookingBody = NonNullable<operations["patchBooking"]["requestBody"]>["content"]["application/json"];
 /** Request body for `sb.resources.update()`. */
@@ -30661,7 +30973,11 @@ 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>;
-        getAssignments(query?: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<Assignment[]>;
+        assignments: {
+            list(query?: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<Assignment[]>;
+            create(assignment: CreateAssignmentBody, options?: SpacebringRequestOptions): Promise<Assignment>;
+            update(assignmentId: string, assignment: PatchAssignmentBody, options?: SpacebringRequestOptions): Promise<undefined>;
+        };
         bookings: {
             list(query?: GetBookingsQuery, options?: SpacebringRequestOptions): Promise<{
                 bookings: Booking[];
@@ -30899,4 +31215,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 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 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 Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchBookingBody, 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 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 CreateAssignmentBody, 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 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 Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchAssignmentBody, type PatchBookingBody, 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 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 };