@izak0s/spacebring-api 13.0.0 → 15.0.0

package/README.md

@@ -15,7 +15,7 @@ A fully-typed TypeScript client for the [Spacebring](https://www.spacebring.com)
 
 ## Features
 
-- **<!-- coverage -->209 operations across 22 resource groups<!-- /coverage -->** — the full Spacebring API surface
+- **<!-- coverage -->218 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

@@ -695,6 +695,18 @@ function createBenefits(client, defaults) {
     async createMedia(media, options) {
       return unwrapProp(await client.POST("/benefits/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /benefits/v1/media");
     },
+    /**
+     * Partially update a benefit
+     *
+     * Update the fields of a benefit that the request sets; omitted fields keep their current values.
+     *
+     * @param benefitId The id of the benefit
+     * @param benefit The `benefit` payload.
+     * @param options Request options (abort signal).
+     */
+    async patch(benefitId, benefit, options) {
+      return unwrap(await client.PATCH("/benefits/v1/{benefitId}", { params: { path: { benefitId } }, body: { benefit }, signal: options?.signal }), "PATCH /benefits/v1/{benefitId}");
+    },
     applications: {
       /**
        * Retrieve applications
@@ -845,6 +857,17 @@ function createBilling(client, defaults) {
        */
       async preview(creditNote, options) {
         return unwrapProp(await client.POST("/billing/credit_notes/v1/preview", { body: { creditNote }, signal: options?.signal }), "creditNote", "POST /billing/credit_notes/v1/preview");
+      },
+      /**
+       * Void a credit note
+       *
+       * Void a credit note permanently: the amount it took off the invoice is owed again. Only an issued credit note of type `prePayment` can be voided, while its invoice is still issued, unpaid and has no payment in progress.
+       *
+       * @param id The id of the credit note
+       * @param options Request options (abort signal).
+       */
+      async void(id, options) {
+        return unwrapProp(await client.PUT("/billing/credit_notes/v1/{id}/void", { params: { path: { id } }, signal: options?.signal }), "creditNote", "PUT /billing/credit_notes/v1/{id}/void");
       }
     },
     invoices: {
@@ -1613,6 +1636,18 @@ function createEvents(client, defaults) {
     async createMedia(media, options) {
       return unwrapProp(await client.POST("/events/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /events/v1/media");
     },
+    /**
+     * Partially update an event
+     *
+     * Update the fields of an event that the request sets; omitted fields keep their current values.
+     *
+     * @param id The id of the event.
+     * @param event The `event` payload.
+     * @param options Request options (abort signal).
+     */
+    async patch(id, event, options) {
+      return unwrap(await client.PATCH("/events/v1/{id}", { params: { path: { id } }, body: { event }, signal: options?.signal }), "PATCH /events/v1/{id}");
+    },
     tickets: {
       /**
        * Retrieve tickets
@@ -1829,6 +1864,18 @@ function createFeed(client, defaults) {
        */
       async getLikes(id, options) {
         return unwrapProp(await client.GET("/feed/posts/v1/{id}/likes", { params: { path: { id } }, signal: options?.signal }), "likes", "GET /feed/posts/v1/{id}/likes");
+      },
+      /**
+       * Partially update a post
+       *
+       * Update the fields of a feed post that the request sets; omitted fields keep their current values.
+       *
+       * @param id The id of the post.
+       * @param post The `post` payload.
+       * @param options Request options (abort signal).
+       */
+      async patch(id, post, options) {
+        return unwrap(await client.PATCH("/feed/posts/v1/{id}", { params: { path: { id } }, body: { post }, signal: options?.signal }), "PATCH /feed/posts/v1/{id}");
       }
     }
   };
@@ -1989,6 +2036,15 @@ function createPackages(client, defaults) {
         "packages"
       );
     },
+    /**
+     * Retrieve a package
+     *
+     * @param packageId The id of the package.
+     * @param options Request options (abort signal).
+     */
+    async get(packageId, options) {
+      return unwrapProp(await client.GET("/packages/v1/{packageId}", { params: { path: { packageId } }, signal: options?.signal }), "package", "GET /packages/v1/{packageId}");
+    },
     /** Create a package */
     async create(packageBody, options) {
       return unwrapProp(await client.POST("/packages/v1", { body: { package: packageBody }, signal: options?.signal }), "package", "POST /packages/v1");
@@ -2156,6 +2212,15 @@ 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}");
     },
+    /**
+     * Delete a resource
+     *
+     * @param resourceId The id of the resource.
+     * @param options Request options (abort signal).
+     */
+    async delete(resourceId, options) {
+      return unwrap(await client.DELETE("/resources/v1/{resourceId}", { params: { path: { resourceId } }, signal: options?.signal }), "DELETE /resources/v1/{resourceId}");
+    },
     /**
      * Create a media upload
      *
@@ -2196,6 +2261,15 @@ function createResources(client, defaults) {
           "assignments"
         );
       },
+      /**
+       * Get a resource assignment
+       *
+       * @param assignmentId The id of the assignment.
+       * @param options Request options (abort signal).
+       */
+      async get(assignmentId, options) {
+        return unwrapProp(await client.GET("/resources/v1/assignments/{assignmentId}", { params: { path: { assignmentId } }, signal: options?.signal }), "assignment", "GET /resources/v1/assignments/{assignmentId}");
+      },
       /**
        * Create a resource assignment
        *
@@ -2215,6 +2289,17 @@ function createResources(client, defaults) {
        */
       async update(assignmentId, assignment, options) {
         return unwrap(await client.PATCH("/resources/v1/assignments/{assignmentId}", { params: { path: { assignmentId } }, body: { assignment }, signal: options?.signal }), "PATCH /resources/v1/assignments/{assignmentId}");
+      },
+      /**
+       * Delete a resource assignment
+       *
+       * Delete a resource assignment. An assignment created by a subscription is removed with its subscription instead.
+       *
+       * @param assignmentId The id of the assignment.
+       * @param options Request options (abort signal).
+       */
+      async delete(assignmentId, options) {
+        return unwrap(await client.DELETE("/resources/v1/assignments/{assignmentId}", { params: { path: { assignmentId } }, signal: options?.signal }), "DELETE /resources/v1/assignments/{assignmentId}");
       }
     },
     bookings: {
@@ -2282,7 +2367,7 @@ function createShop(client, defaults) {
       /**
        * Retrieve categories
        *
-       * Retrieve all shop categories in the location.
+       * Retrieve the shop categories of a location, or of every location in the network.
        */
       async list(query, options) {
         return unwrapProp(await client.GET("/shop/categories/v1", { params: { query }, signal: options?.signal }), "categories", "GET /shop/categories/v1");
@@ -2431,6 +2516,18 @@ function createShop(client, defaults) {
        */
       async createMedia(media, options) {
         return unwrapProp(await client.POST("/shop/products/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /shop/products/v1/media");
+      },
+      /**
+       * Partially update a product
+       *
+       * Update the fields of a product that the request sets; omitted fields keep their current values.
+       *
+       * @param productId The id of the product.
+       * @param product The `product` payload.
+       * @param options Request options (abort signal).
+       */
+      async patch(productId, product, options) {
+        return unwrap(await client.PATCH("/shop/products/v1/{productId}", { params: { path: { productId } }, body: { product }, signal: options?.signal }), "PATCH /shop/products/v1/{productId}");
       }
     }
   };