@izak0s/spacebring-api 10.2.0 → 10.4.0

package/README.md

@@ -15,7 +15,7 @@ A fully-typed TypeScript client for the [Spacebring](https://www.spacebring.com)
 
 ## Features
 
-- **<!-- coverage -->197 operations across 21 resource groups<!-- /coverage -->** — the full Spacebring API surface
+- **<!-- coverage -->209 operations across 22 resource groups<!-- /coverage -->** — the full Spacebring API surface
 - **Auto-generated** from the official OpenAPI spec — types and facade regenerate anytime the spec changes
 - **Nested, discoverable API** — `sb.billing.invoices.pay(id)`, `sb.visitors.visits.checkIn(body)`
 - **Auto-pagination** — every paginated list endpoint has an `iterate()` async generator that walks `nextPageToken` for you

package/dist/index.cjs

@@ -1058,6 +1058,58 @@ function createBilling(client, defaults) {
   };
 }
 
+// src/generated/resources/checkIns.ts
+function createCheckins(client, defaults) {
+  return {
+    /**
+     * Retrieve check-ins
+     *
+     * Retrieve the check-ins of a location, newest arrival first. With bearer token authentication, the user must be an administrator of the location.
+     */
+    async list(query, options) {
+      return unwrap(await client.GET("/check_ins/v1", { params: { query }, signal: options?.signal }), "GET /check_ins/v1");
+    },
+    /**
+     * Retrieve check-ins — iterates every item across all pages.
+     *
+     * Retrieve the check-ins of a location, newest arrival first. With bearer token authentication, the user must be an administrator of the location.
+     */
+    iterate(query, options) {
+      return paginate(
+        async (nextPageToken) => unwrap(await client.GET("/check_ins/v1", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /check_ins/v1"),
+        "checkIns"
+      );
+    },
+    /**
+     * Get a check-in
+     *
+     * Get a check-in by its id. With bearer token authentication, the user must be an administrator of the check-in's location.
+     *
+     * @param checkInId The ID of the check-in.
+     * @param options Request options (abort signal).
+     */
+    async get(checkInId, options) {
+      return unwrapProp(await client.GET("/check_ins/v1/{checkInId}", { params: { path: { checkInId } }, signal: options?.signal }), "checkIn", "GET /check_ins/v1/{checkInId}");
+    },
+    /**
+     * Check in
+     *
+     * Record an arrival for a booking, an event ticket, a visit, or a member's subscription. Identify what to check in with its check-in id, with the location and a six-digit code, or with the location and a customer ref to check a member in without a code. With bearer token authentication, the user must be an administrator of the location.
+     */
+    async checkIn(body, options) {
+      return unwrapProp(await client.POST("/check_ins/v1/checkin", { body, signal: options?.signal }), "checkIn", "POST /check_ins/v1/checkin");
+    },
+    /**
+     * Check out
+     *
+     * Record a departure on an open check-in. Identify it with its check-in id, or with the location and the six-digit code it was opened with. With bearer token authentication, the user must be an administrator of the location.
+     */
+    async checkOut(body, options) {
+      return unwrapProp(await client.POST("/check_ins/v1/checkout", { body, signal: options?.signal }), "checkIn", "POST /check_ins/v1/checkout");
+    }
+  };
+}
+
 // src/generated/resources/community.ts
 function createCommunity(client, defaults) {
   return {
@@ -1107,6 +1159,14 @@ function createCommunity(client, defaults) {
        */
       async update(id, company, options) {
         return unwrapProp(await client.PUT("/community/companies/v1/{id}", { params: { path: { id } }, body: { company }, signal: options?.signal }), "company", "PUT /community/companies/v1/{id}");
+      },
+      /**
+       * Create a logo upload
+       *
+       * Create an upload for a company logo. 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 `logo.key` when creating or updating a company within an hour; a logo that is not attached by then is discarded.
+       */
+      async createMedia(media, options) {
+        return unwrapProp(await client.POST("/community/companies/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /community/companies/v1/media");
       }
     },
     memberships: {
@@ -1337,7 +1397,7 @@ function createContracts(client, defaults) {
       /**
        * Create a template
        *
-       * Create a contract template from an uploaded file.
+       * Create a contract template from a .docx file uploaded through the template upload endpoint.
        */
       async create(template, options) {
         return unwrapProp(await client.POST("/contracts/templates/v1", { body: { template }, signal: options?.signal }), "template", "POST /contracts/templates/v1");
@@ -1345,7 +1405,7 @@ function createContracts(client, defaults) {
       /**
        * Update a template
        *
-       * Update a contract template.
+       * Update a contract template. A new file is uploaded through the template upload endpoint.
        *
        * @param templateId The id of the template.
        * @param template The `template` payload.
@@ -1365,6 +1425,14 @@ function createContracts(client, defaults) {
       async delete(templateId, options) {
         return unwrap(await client.DELETE("/contracts/templates/v1/{templateId}", { params: { path: { templateId } }, signal: options?.signal }), "DELETE /contracts/templates/v1/{templateId}");
       },
+      /**
+       * Create a template upload
+       *
+       * Create a media upload for a contract template file, a .docx document of up to 50 MB. 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 `template.file.key` when creating or updating a template within an hour; a file that is not attached by then is discarded.
+       */
+      async createMedia(media, options) {
+        return unwrapProp(await client.POST("/contracts/templates/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /contracts/templates/v1/media");
+      },
       /**
        * Duplicate a template
        *
@@ -1615,6 +1683,14 @@ function createEvents(client, defaults) {
 // src/generated/resources/feed.ts
 function createFeed(client, defaults) {
   return {
+    /**
+     * Create a media upload
+     *
+     * Create a media upload for an image or a video in a post. 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 in `media[].key` when creating or updating a post within an hour; a file that is not attached by then is discarded. A video must declare its `width` and `height`; an image's dimensions are read from the file.
+     */
+    async createMedia(media, options) {
+      return unwrapProp(await client.POST("/feed/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /feed/v1/media");
+    },
     comments: {
       /**
        * Create a post comment
@@ -1834,6 +1910,22 @@ function createGuides(client, defaults) {
      */
     async delete(guideId, options) {
       return unwrap(await client.DELETE("/guides/v1/{guideId}", { params: { path: { guideId } }, signal: options?.signal }), "DELETE /guides/v1/{guideId}");
+    },
+    /**
+     * Create an attachment upload
+     *
+     * Create an upload for a file to attach to a guide, of any type up to 50 MB. 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 in `attachments[].key` when creating or updating a guide within an hour; a file that is not attached by then is discarded. The file is served as a download under the declared name.
+     */
+    async createAttachment(attachment, options) {
+      return unwrapProp(await client.POST("/guides/v1/attachments", { body: { attachment }, signal: options?.signal }), "attachment", "POST /guides/v1/attachments");
+    },
+    /**
+     * Create a media upload
+     *
+     * Create a media upload for an image or a video in a guide. 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, add the returned url to the guide `description` as a Markdown image, `![alt text](url)`, when creating or updating a guide within an hour; a file that is not attached by then is discarded. A video must declare its `width` and `height`; an image's dimensions are read from the file.
+     */
+    async createMedia(media, options) {
+      return unwrapProp(await client.POST("/guides/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /guides/v1/media");
     }
   };
 }
@@ -2060,6 +2152,14 @@ function createResources(client, defaults) {
     async update(resourceId, resource, options) {
       return unwrap(await client.PATCH("/resources/v1/{resourceId}", { params: { path: { resourceId } }, body: { resource }, signal: options?.signal }), "PATCH /resources/v1/{resourceId}");
     },
+    /**
+     * Create a media upload
+     *
+     * Create a media upload for a resource photo. 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, add the returned key to `media` when creating or updating a resource within an hour; an image that is not attached by then is discarded. A resource holds up to 10 photos, the first being its cover.
+     */
+    async createMedia(media, options) {
+      return unwrapProp(await client.POST("/resources/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /resources/v1/media");
+    },
     /**
      * Check resource availability
      *
@@ -2319,6 +2419,14 @@ function createShop(client, defaults) {
        */
       async delete(productId, options) {
         return unwrap(await client.DELETE("/shop/products/v1/{productId}", { params: { path: { productId } }, signal: options?.signal }), "DELETE /shop/products/v1/{productId}");
+      },
+      /**
+       * Create a media upload
+       *
+       * Create a media upload for a product 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 product within an hour; an image that is not attached by then is discarded.
+       */
+      async createMedia(media, options) {
+        return unwrapProp(await client.POST("/shop/products/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /shop/products/v1/media");
       }
     }
   };
@@ -2456,6 +2564,14 @@ function createSupport(client, defaults) {
       async create(ticket, options) {
         return unwrap(await client.POST("/support/tickets/v1", { body: { ticket }, signal: options?.signal }), "POST /support/tickets/v1");
       },
+      /**
+       * Create a ticket media upload
+       *
+       * Create a media upload for a ticket comment attachment, a file of any type up to 50 MB. 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 `activity.attachments[0].key` when creating a ticket comment within 25 minutes; a file that is not attached by then is discarded.
+       */
+      async createMedia(media, options) {
+        return unwrapProp(await client.POST("/support/tickets/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /support/tickets/v1/media");
+      },
       /**
        * Update a ticket's assignee
        *
@@ -2496,7 +2612,7 @@ function createSupport(client, defaults) {
         /**
          * Create a ticket comment
          *
-         * Create a support ticket comment.
+         * Create a support ticket comment. To attach a file, create a media upload first, send the file, then pass its key as `activity.attachments[0].key`; a 409 response means the file has not been received yet, so retry shortly.
          */
         async create(activity, options) {
           return unwrapProp(await client.POST("/support/tickets/v1/comment", { body: { activity }, signal: options?.signal }), "activity", "POST /support/tickets/v1/comment");
@@ -2874,6 +2990,7 @@ function createResources2(client, defaults) {
     altCurrencies: createAltcurrencies(client, defaults),
     benefits: createBenefits(client, defaults),
     billing: createBilling(client, defaults),
+    checkIns: createCheckins(client, defaults),
     community: createCommunity(client, defaults),
     contracts: createContracts(client, defaults),
     discounts: createDiscounts(client, defaults),