@izak0s/spacebring-api 16.0.0 → 16.1.0

package/dist/index.d.ts

@@ -2129,6 +2129,26 @@ interface paths {
         patch?: never;
         trace?: never;
     };
+    "/plans/v1/media": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Create a media upload
+         * @description Create a media upload for a plan cover image. The response carries a presigned URL: send the raw file bytes with a PUT request within a minute, using exactly the headers returned. Once the file is stored, pass the returned key as <code>media[0].key</code> when creating or updating a plan within an hour; an image that is not attached by then is discarded. <h3>OAuth</h3>Required scopes: <code>plans</code>
+         */
+        post: operations["createPlanMedia"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/plans/v1/{planId}": {
         parameters: {
             query?: never;
@@ -7162,6 +7182,11 @@ interface components {
                  * @enum {string}
                  */
                 status: "draft" | "issued" | "signed" | "declined" | "terminated";
+                /**
+                 * Format: uuid
+                 * @description ID of the subscription created when the contract was issued, present when the action is subscription.
+                 */
+                subscriptionRef?: string;
                 /**
                  * Format: uuid
                  * @description ID of the template used to generate this contract.
@@ -7379,6 +7404,11 @@ interface components {
                  * @enum {string}
                  */
                 status: "draft" | "issued" | "signed" | "declined" | "terminated";
+                /**
+                 * Format: uuid
+                 * @description ID of the subscription created when the contract was issued, present when the action is subscription.
+                 */
+                subscriptionRef?: string;
                 /**
                  * Format: uuid
                  * @description ID of the template used to generate this contract.
@@ -7599,6 +7629,8 @@ interface components {
             percentOff?: number | null;
             /** @description Product types the coupon applies to. */
             productTypes: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "officeBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
+            /** @description Name of the coupon. Absent when the coupon has none and is named after its discount and the products it applies to. */
+            title?: string;
             /**
              * @description Deprecated coupon category.
              * @enum {string}
@@ -9370,6 +9402,13 @@ interface components {
                  * @description ID of the location this plan belongs to.
                  */
                 locationRef: string;
+                /** @description Media files attached to this plan. The first is its cover image. */
+                media: {
+                    /** @description Storage key of the media file. */
+                    key: string;
+                    /** @description Public URL of the media file. */
+                    url: string;
+                }[];
                 /**
                  * @description Billing period of the plan.
                  * @enum {string}
@@ -9543,6 +9582,13 @@ interface components {
              * @description ID of the location this plan belongs to.
              */
             locationRef: string;
+            /** @description Media files attached to this plan. The first is its cover image. */
+            media: {
+                /** @description Storage key of the media file. */
+                key: string;
+                /** @description Public URL of the media file. */
+                url: string;
+            }[];
             /**
              * @description Billing period of the plan.
              * @enum {string}
@@ -9573,6 +9619,47 @@ interface components {
             /** @description Display name of the plan. */
             title: string;
         };
+        createPlanMedia: {
+            /** @description The created media upload. */
+            media: {
+                /** @description Storage key of the media file. Pass it as media[0].key when creating or updating a plan. */
+                key: string;
+                /**
+                 * @description MIME type of the image file.
+                 * @enum {string}
+                 */
+                mimeType: "image/gif" | "image/jpeg" | "image/png" | "image/webp";
+                /** @description Size of the image file in bytes. */
+                size: number;
+                /**
+                 * @description Upload status. pending: the file has not been received yet. uploaded: the file is stored and can be attached to a plan. attached: a plan references the file.
+                 * @enum {string}
+                 */
+                status: "pending" | "uploaded" | "attached";
+                /** @description How to upload the file. Send the raw bytes as the request body, not a multipart form. */
+                upload: {
+                    /**
+                     * Format: date-time
+                     * @description ISO timestamp after which the upload URL is rejected.
+                     */
+                    expirationDate: string;
+                    /** @description Headers the PUT request must send exactly as given; the signature covers them. */
+                    headers: {
+                        /** @description Must equal the size declared when the upload was created. */
+                        "Content-Length": string;
+                        /** @description Must equal the mimeType declared when the upload was created. */
+                        "Content-Type": string;
+                    };
+                    /**
+                     * @description HTTP method of the upload request.
+                     * @enum {string}
+                     */
+                    method: "PUT";
+                    /** @description Presigned URL to send the raw file bytes to. */
+                    url: string;
+                };
+            };
+        };
         getPlan: {
             /** @description The plan. */
             plan: {
@@ -9715,6 +9802,13 @@ interface components {
                  * @description ID of the location this plan belongs to.
                  */
                 locationRef: string;
+                /** @description Media files attached to this plan. The first is its cover image. */
+                media: {
+                    /** @description Storage key of the media file. */
+                    key: string;
+                    /** @description Public URL of the media file. */
+                    url: string;
+                }[];
                 /**
                  * @description Billing period of the plan.
                  * @enum {string}
@@ -10025,7 +10119,7 @@ interface components {
                 /** @description Brivo access group reference. */
                 brivoGroupRef?: number | null;
                 /**
-                 * @description Buffer time blocked before each booking.
+                 * @description Time kept free before and after each booking of a room or desk. Other resource types ignore it.
                  * @enum {string}
                  */
                 bufferTime: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
@@ -10748,7 +10842,7 @@ interface components {
                 /** @description Brivo access group reference. */
                 brivoGroupRef?: number | null;
                 /**
-                 * @description Buffer time blocked before each booking.
+                 * @description Time kept free before and after each booking of a room or desk. Other resource types ignore it.
                  * @enum {string}
                  */
                 bufferTime: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
@@ -23868,6 +23962,8 @@ interface components {
                         percentOff?: number;
                         /** @description Product types the coupon applies to. */
                         productTypes: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "officeBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
+                        /** @description Name of the coupon. An empty title leaves the coupon named after its discount and the products it applies to. */
+                        title?: string;
                     };
                 };
             };
@@ -23875,10 +23971,10 @@ interface components {
         updateCoupon: {
             content: {
                 "application/json": {
-                    /** @description Coupon fields to update. */
+                    /** @description Coupon fields to update. Fields left out keep their current value. */
                     coupon: {
-                        /** @description Limited items to set on the coupon. */
-                        limitedItems: {
+                        /** @description Limited items to set on the coupon. Only a coupon created with limited items enabled accepts them. */
+                        limitedItems?: {
                             /** @description Replacement list of limited items for the coupon. */
                             values: {
                                 /**
@@ -23893,6 +23989,8 @@ interface components {
                                 type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "officeBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
                             }[];
                         };
+                        /** @description Name of the coupon. An empty title leaves the coupon named after its discount and the products it applies to. */
+                        title?: string;
                     };
                 };
             };
@@ -24666,6 +24764,14 @@ interface components {
                          * @description ID of the location this plan belongs to.
                          */
                         locationRef: string;
+                        /**
+                         * @description Media files to attach. The url is generated server-side.
+                         * @default []
+                         */
+                        media?: {
+                            /** @description Storage key of the media file, as returned by the media upload endpoint. */
+                            key: string;
+                        }[];
                         /**
                          * @description Billing period of the plan.
                          * @enum {string}
@@ -24712,6 +24818,22 @@ interface components {
                 };
             };
         };
+        createPlanMedia: {
+            content: {
+                "application/json": {
+                    /** @description File to upload. */
+                    media: {
+                        /**
+                         * @description MIME type of the file to upload.
+                         * @enum {string}
+                         */
+                        mimeType: "image/gif" | "image/jpeg" | "image/png" | "image/webp";
+                        /** @description Size of the file in bytes. The upload is rejected when the body length differs. */
+                        size: number;
+                    };
+                };
+            };
+        };
         updatePlan: {
             content: {
                 "application/json": {
@@ -24802,6 +24924,11 @@ interface components {
                                 productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "officeBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
                             };
                         }[];
+                        /** @description Media files to attach, replacing the current ones. Pass an empty array to remove them. The url is generated server-side. */
+                        media?: {
+                            /** @description Storage key of the media file, as returned by the media upload endpoint. */
+                            key: string;
+                        }[];
                         /** @description Price of the plan. */
                         price?: number;
                         /** @description Printing integration settings. */
@@ -24874,7 +25001,7 @@ interface components {
                         /** @description Brivo access group reference. */
                         brivoGroupRef?: number | null;
                         /**
-                         * @description Buffer time blocked before each booking.
+                         * @description Time kept free before and after each booking of a room or desk. Other resource types ignore it.
                          * @enum {string}
                          */
                         bufferTime?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
@@ -25381,7 +25508,7 @@ interface components {
                         /** @description Brivo access group reference. */
                         brivoGroupRef?: number | null;
                         /**
-                         * @description Buffer time blocked before each booking.
+                         * @description Time kept free before and after each booking of a room or desk. Other resource types ignore it.
                          * @enum {string}
                          */
                         bufferTime?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
@@ -32863,6 +32990,38 @@ interface operations {
             };
         };
     };
+    createPlanMedia: {
+        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"]["createPlanMedia"];
+        responses: {
+            /** @description Created */
+            201: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["createPlanMedia"];
+                };
+            };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["responseError"];
+                };
+            };
+        };
+    };
     getPlan: {
         parameters: {
             query?: never;
@@ -36583,6 +36742,8 @@ interface GetRegistrationsQuery {
 
 /** A Plan entity as returned by the Spacebring API. */
 type Plan = NonNullable<components["schemas"]["plan"]>;
+/** A PlanMedia entity as returned by the Spacebring API. */
+type PlanMedia = NonNullable<operations["createPlanMedia"]["responses"][201]["content"]["application/json"]["media"]>;
 /** Query parameters for `sb.plans.list()`. */
 interface GetPlansQuery {
     /** @deprecated Only applies together with resourceRef. Filter the plans.tiers of `GET /resources/v1/{resourceId}` by their entire field instead. When listing plans for a resource, filter by entire resource vs partial tiers. Pass true or false. */
@@ -36598,6 +36759,8 @@ interface GetPlansQuery {
 }
 /** Request body for `sb.plans.create()`. */
 type CreatePlanBody = NonNullable<NonNullable<operations["createPlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
+/** Request body for `sb.plans.createMedia()`. */
+type CreatePlanMediaBody = NonNullable<NonNullable<operations["createPlanMedia"]["requestBody"]>["content"]["application/json"]["media"]>;
 /** Request body for `sb.plans.update()`. */
 type UpdatePlanBody = NonNullable<NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
 
@@ -37420,6 +37583,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
         create(plan: CreatePlanBody, options?: SpacebringRequestOptions): Promise<Plan>;
         update(planId: string, plan: UpdatePlanBody, options?: SpacebringRequestOptions): Promise<undefined>;
         delete(planId: string, options?: SpacebringRequestOptions): Promise<undefined>;
+        createMedia(media: CreatePlanMediaBody, options?: SpacebringRequestOptions): Promise<PlanMedia>;
     };
     registrations: {
         list(query?: GetRegistrationsQuery, options?: SpacebringRequestOptions): Promise<{
@@ -37700,4 +37864,4 @@ declare class SpacebringError extends Error {
 }
 
 export { Spacebring, SpacebringError };
-export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };
+export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreatePlanMediaBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, PlanMedia, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };

package/dist/index.js

@@ -2103,6 +2103,14 @@ function createPlans(client, defaults) {
      */
     async delete(planId, options) {
       return unwrap(await client.DELETE("/plans/v1/{planId}", { params: { path: { planId } }, signal: options?.signal }), "DELETE /plans/v1/{planId}");
+    },
+    /**
+     * Create a media upload
+     *
+     * Create a media upload for a plan cover image. The response carries a presigned URL: send the raw file bytes with a PUT request within a minute, using exactly the headers returned. Once the file is stored, pass the returned key as `media[0].key` when creating or updating a plan within an hour; an image that is not attached by then is discarded.
+     */
+    async createMedia(media, options) {
+      return unwrapProp(await client.POST("/plans/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /plans/v1/media");
     }
   };
 }