@izak0s/spacebring-api 1.12.0 → 2.0.0

package/README.md

@@ -15,12 +15,12 @@ A fully-typed TypeScript client for the [Spacebring](https://www.spacebring.com)
 
 ## Features
 
-- **<!-- coverage -->163 operations across 20 resource groups<!-- /coverage -->** — the full Spacebring API surface
+- **<!-- coverage -->182 operations across 21 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
-- **Ergonomic returns** — single-property response envelopes are unwrapped: entities and plain arrays come back directly
-- **Readable, named types** — entities (`Booking`, `Invoice`) and query parameters (`GetBookingsQuery`) are exported named types, so hovers show `Booking[]` instead of generated type soup, and enum filters are literal unions
+- **Ergonomic payloads** — single-property envelopes are unwrapped in both directions: responses hand you the entity or array directly, and create/update methods take the payload flat (`sb.plans.create({ title, price })` instead of `{ plan: { … } }`)
+- **Readable, named types** — entities (`Booking`, `Invoice`) and query parameters (`GetBookingsQuery`) are exported named types, so hovers show `Booking[]` or `{ invoice?: Invoice; payment?: Payment }` instead of generated type soup, and enum filters are literal unions
 - **Rich error handling** — non-2xx responses throw a typed `SpacebringError` carrying the status, parsed body, and the operation that failed; malformed 2xx bodies and stuck pagination tokens throw instead of failing silently
 - **Resilient by default** — automatic retries for rate limits, gateway errors, and network failures (never replaying non-idempotent requests); optional per-attempt timeouts and `AbortSignal` cancellation on every method
 - **Zero runtime dependencies** — Node ≥ 20, `fetch`-based; type declarations are fully self-contained (TypeScript ≥ 5.4)
@@ -72,7 +72,14 @@ try {
 }
 ```
 
-Writes read the same, and endpoints that return more than one payload keep the envelope intact:
+Writes take the payload directly — no `{ plan: { … } }` wrapper around request bodies:
+
+```ts
+const plan = await sb.plans.create({ locationRef, title: "Day pass bundle", price: 99, period: "month" });
+await sb.plans.update(plan.id, { price: 149 });
+```
+
+Endpoints that genuinely send or return more than one payload keep the envelope intact:
 
 ```ts
 const { invoice, payment } = await sb.billing.invoices.pay(invoiceId, {

package/dist/index.cjs

@@ -1221,6 +1221,16 @@ function createContracts(client, defaults) {
     async create(contract, options) {
       return unwrapProp(await client.POST("/contracts/v1", { body: { contract }, signal: options?.signal }), "contract", "POST /contracts/v1");
     },
+    /**
+     * Update a contract
+     *
+     * @param contractId The id of the contract.
+     * @param contract The `contract` payload.
+     * @param options Request options (abort signal).
+     */
+    async update(contractId, contract, options) {
+      return unwrap(await client.PATCH("/contracts/v1/{contractId}", { params: { path: { contractId } }, body: { contract }, signal: options?.signal }), "PATCH /contracts/v1/{contractId}");
+    },
     /**
      * Delete a contract
      *
@@ -1230,6 +1240,18 @@ function createContracts(client, defaults) {
     async delete(contractId, options) {
       return unwrap(await client.DELETE("/contracts/v1/{contractId}", { params: { path: { contractId } }, signal: options?.signal }), "DELETE /contracts/v1/{contractId}");
     },
+    /**
+     * Decline a contract
+     *
+     * Mark a contract signer as declined. Declining also declines the contract.
+     *
+     * @param contractId The id of the contract.
+     * @param signerId The id of the contract signer.
+     * @param options Request options (abort signal).
+     */
+    async declineContract(contractId, signerId, options) {
+      return unwrap(await client.PUT("/contracts/v1/{contractId}/signers/{signerId}/decline", { params: { path: { contractId, signerId } }, signal: options?.signal }), "PUT /contracts/v1/{contractId}/signers/{signerId}/decline");
+    },
     /**
      * Issue a contract
      *
@@ -1240,6 +1262,29 @@ function createContracts(client, defaults) {
     async issue(contractId, signatureMethod, options) {
       return unwrapProp(await client.POST("/contracts/v1/{contractId}/issue", { params: { path: { contractId } }, body: { signatureMethod }, signal: options?.signal }), "contract", "POST /contracts/v1/{contractId}/issue");
     },
+    /**
+     * Resend a contract
+     *
+     * Resend the signature request email to the next pending signer of an issued eSignature contract.
+     *
+     * @param contractId The id of the contract.
+     * @param options Request options (abort signal).
+     */
+    async resend(contractId, options) {
+      return unwrap(await client.POST("/contracts/v1/{contractId}/resend", { params: { path: { contractId } }, signal: options?.signal }), "POST /contracts/v1/{contractId}/resend");
+    },
+    /**
+     * Sign a contract
+     *
+     * Mark a contract signer as signed. When all signers have signed, the contract becomes signed.
+     *
+     * @param contractId The id of the contract.
+     * @param signerId The id of the contract signer.
+     * @param options Request options (abort signal).
+     */
+    async signContract(contractId, signerId, options) {
+      return unwrap(await client.PUT("/contracts/v1/{contractId}/signers/{signerId}/sign", { params: { path: { contractId, signerId } }, signal: options?.signal }), "PUT /contracts/v1/{contractId}/signers/{signerId}/sign");
+    },
     /**
      * Terminate a contract
      *
@@ -1249,6 +1294,80 @@ function createContracts(client, defaults) {
      */
     async terminate(contractId, reason, options) {
       return unwrap(await client.PATCH("/contracts/v1/{contractId}/terminate", { params: { path: { contractId } }, body: { reason }, signal: options?.signal }), "PATCH /contracts/v1/{contractId}/terminate");
+    },
+    templates: {
+      /**
+       * Retrieve templates
+       *
+       * Retrieve all contract templates in the location.
+       */
+      async list(query, options) {
+        return unwrap(await client.GET("/contracts/templates/v1", { params: { query }, signal: options?.signal }), "GET /contracts/templates/v1");
+      },
+      /**
+       * Retrieve templates — iterates every item across all pages.
+       *
+       * Retrieve all contract templates in the location.
+       */
+      iterate(query, options) {
+        return paginate(
+          async (nextPageToken) => unwrap(await client.GET("/contracts/templates/v1", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /contracts/templates/v1"),
+          "templates"
+        );
+      },
+      /**
+       * Retrieve a template
+       *
+       * Retrieve a contract template.
+       *
+       * @param templateId The id of the template.
+       * @param options Request options (abort signal).
+       */
+      async get(templateId, options) {
+        return unwrapProp(await client.GET("/contracts/templates/v1/{templateId}", { params: { path: { templateId } }, signal: options?.signal }), "template", "GET /contracts/templates/v1/{templateId}");
+      },
+      /**
+       * Create a template
+       *
+       * Create a contract template from an uploaded file.
+       */
+      async create(template, options) {
+        return unwrapProp(await client.POST("/contracts/templates/v1", { body: { template }, signal: options?.signal }), "template", "POST /contracts/templates/v1");
+      },
+      /**
+       * Update a template
+       *
+       * Update a contract template.
+       *
+       * @param templateId The id of the template.
+       * @param template The `template` payload.
+       * @param options Request options (abort signal).
+       */
+      async update(templateId, template, options) {
+        return unwrap(await client.PATCH("/contracts/templates/v1/{templateId}", { params: { path: { templateId } }, body: { template }, signal: options?.signal }), "PATCH /contracts/templates/v1/{templateId}");
+      },
+      /**
+       * Delete a template
+       *
+       * Delete a contract template.
+       *
+       * @param templateId The id of the template.
+       * @param options Request options (abort signal).
+       */
+      async delete(templateId, options) {
+        return unwrap(await client.DELETE("/contracts/templates/v1/{templateId}", { params: { path: { templateId } }, signal: options?.signal }), "DELETE /contracts/templates/v1/{templateId}");
+      },
+      /**
+       * Duplicate a template
+       *
+       * Duplicate a contract template, creating a copy with the same title and file.
+       *
+       * @param templateId The id of the template.
+       * @param options Request options (abort signal).
+       */
+      async duplicate(templateId, options) {
+        return unwrapProp(await client.POST("/contracts/templates/v1/{templateId}/duplicate", { params: { path: { templateId } }, signal: options?.signal }), "template", "POST /contracts/templates/v1/{templateId}/duplicate");
+      }
     }
   };
 }
@@ -1256,6 +1375,25 @@ function createContracts(client, defaults) {
 // src/generated/resources/discounts.ts
 function createDiscounts(client, defaults) {
   return {
+    /**
+     * Retrieve redemptions — iterates every item across all pages.
+     *
+     * Retrieve all discount redemptions. Either couponRef or promocodeRef is required.
+     */
+    iterateRedemptions(query, options) {
+      return paginate(
+        async (nextPageToken) => unwrap(await client.GET("/discounts/v1/redemptions", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /discounts/v1/redemptions"),
+        "redemptions"
+      );
+    },
+    /**
+     * Retrieve redemptions
+     *
+     * Retrieve all discount redemptions. Either couponRef or promocodeRef is required.
+     */
+    async listRedemptions(query, options) {
+      return unwrap(await client.GET("/discounts/v1/redemptions", { params: { query }, signal: options?.signal }), "GET /discounts/v1/redemptions");
+    },
     coupons: {
       /**
        * Retrieve coupons
@@ -1263,7 +1401,7 @@ function createDiscounts(client, defaults) {
        * Retrieve all coupons in the location.
        */
       async list(query, options) {
-        return unwrap(await client.GET("/discounts/coupons/v1", { params: { query }, signal: options?.signal }), "GET /discounts/coupons/v1");
+        return unwrap(await client.GET("/discounts/v1/coupons", { params: { query }, signal: options?.signal }), "GET /discounts/v1/coupons");
       },
       /**
        * Retrieve coupons — iterates every item across all pages.
@@ -1272,7 +1410,7 @@ function createDiscounts(client, defaults) {
        */
       iterate(query, options) {
         return paginate(
-          async (nextPageToken) => unwrap(await client.GET("/discounts/coupons/v1", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /discounts/coupons/v1"),
+          async (nextPageToken) => unwrap(await client.GET("/discounts/v1/coupons", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /discounts/v1/coupons"),
           "coupons"
         );
       },
@@ -1283,11 +1421,11 @@ function createDiscounts(client, defaults) {
        * @param options Request options (abort signal).
        */
       async get(id, options) {
-        return unwrapProp(await client.GET("/discounts/coupons/v1/{id}", { params: { path: { id } }, signal: options?.signal }), "coupon", "GET /discounts/coupons/v1/{id}");
+        return unwrapProp(await client.GET("/discounts/v1/coupons/{id}", { params: { path: { id } }, signal: options?.signal }), "coupon", "GET /discounts/v1/coupons/{id}");
       },
       /** Create a coupon */
       async create(coupon, options) {
-        return unwrapProp(await client.POST("/discounts/coupons/v1", { body: { coupon }, signal: options?.signal }), "coupon", "POST /discounts/coupons/v1");
+        return unwrapProp(await client.POST("/discounts/v1/coupons", { body: { coupon }, signal: options?.signal }), "coupon", "POST /discounts/v1/coupons");
       },
       /**
        * Update a coupon
@@ -1297,7 +1435,7 @@ function createDiscounts(client, defaults) {
        * @param options Request options (abort signal).
        */
       async update(id, coupon, options) {
-        return unwrap(await client.PATCH("/discounts/coupons/v1/{id}", { params: { path: { id } }, body: { coupon }, signal: options?.signal }), "PATCH /discounts/coupons/v1/{id}");
+        return unwrap(await client.PATCH("/discounts/v1/coupons/{id}", { params: { path: { id } }, body: { coupon }, signal: options?.signal }), "PATCH /discounts/v1/coupons/{id}");
       },
       /**
        * Delete a coupon
@@ -1306,7 +1444,7 @@ function createDiscounts(client, defaults) {
        * @param options Request options (abort signal).
        */
       async delete(id, options) {
-        return unwrap(await client.DELETE("/discounts/coupons/v1/{id}", { params: { path: { id } }, signal: options?.signal }), "DELETE /discounts/coupons/v1/{id}");
+        return unwrap(await client.DELETE("/discounts/v1/coupons/{id}", { params: { path: { id } }, signal: options?.signal }), "DELETE /discounts/v1/coupons/{id}");
       }
     },
     promocodes: {
@@ -1316,7 +1454,7 @@ function createDiscounts(client, defaults) {
        * Retrieve all promocodes.
        */
       async list(query, options) {
-        return unwrapProp(await client.GET("/discounts/promocodes/v1", { params: { query }, signal: options?.signal }), "promocodes", "GET /discounts/promocodes/v1");
+        return unwrapProp(await client.GET("/discounts/v1/promocodes", { params: { query }, signal: options?.signal }), "promocodes", "GET /discounts/v1/promocodes");
       },
       /**
        * Get a promocode
@@ -1325,11 +1463,11 @@ function createDiscounts(client, defaults) {
        * @param options Request options (abort signal).
        */
       async get(id, options) {
-        return unwrapProp(await client.GET("/discounts/promocodes/v1/{id}", { params: { path: { id } }, signal: options?.signal }), "promocode", "GET /discounts/promocodes/v1/{id}");
+        return unwrapProp(await client.GET("/discounts/v1/promocodes/{id}", { params: { path: { id } }, signal: options?.signal }), "promocode", "GET /discounts/v1/promocodes/{id}");
       },
       /** Create a promocode */
       async create(promocode, options) {
-        return unwrapProp(await client.POST("/discounts/promocodes/v1", { body: { promocode }, signal: options?.signal }), "promocode", "POST /discounts/promocodes/v1");
+        return unwrapProp(await client.POST("/discounts/v1/promocodes", { body: { promocode }, signal: options?.signal }), "promocode", "POST /discounts/v1/promocodes");
       },
       /**
        * Archive a promocode
@@ -1338,28 +1476,7 @@ function createDiscounts(client, defaults) {
        * @param options Request options (abort signal).
        */
       async archive(id, options) {
-        return unwrapProp(await client.PUT("/discounts/promocodes/v1/{id}/archive", { params: { path: { id } }, signal: options?.signal }), "promocode", "PUT /discounts/promocodes/v1/{id}/archive");
-      }
-    },
-    redemptions: {
-      /**
-       * Retrieve redemptions
-       *
-       * Retrieve all discount redemptions. Either couponRef or promocodeRef is required.
-       */
-      async list(query, options) {
-        return unwrap(await client.GET("/discounts/redemptions/v1", { params: { query }, signal: options?.signal }), "GET /discounts/redemptions/v1");
-      },
-      /**
-       * Retrieve redemptions — iterates every item across all pages.
-       *
-       * Retrieve all discount redemptions. Either couponRef or promocodeRef is required.
-       */
-      iterate(query, options) {
-        return paginate(
-          async (nextPageToken) => unwrap(await client.GET("/discounts/redemptions/v1", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /discounts/redemptions/v1"),
-          "redemptions"
-        );
+        return unwrapProp(await client.PUT("/discounts/v1/promocodes/{id}/archive", { params: { path: { id } }, signal: options?.signal }), "promocode", "PUT /discounts/v1/promocodes/{id}/archive");
       }
     }
   };
@@ -1380,10 +1497,26 @@ function createEvents(client, defaults) {
     async create(event, options) {
       return unwrapProp(await client.POST("/events/v1", { body: { event }, signal: options?.signal }), "event", "POST /events/v1");
     },
+    /** Update an event */
+    async update(id, event, options) {
+      return unwrapProp(await client.PUT("/events/v1/{id}", { params: { path: { id } }, body: { event }, signal: options?.signal }), "event", "PUT /events/v1/{id}");
+    },
     /** Delete an event */
     async delete(id, options) {
       return unwrap(await client.DELETE("/events/v1/{id}", { params: { path: { id } }, signal: options?.signal }), "DELETE /events/v1/{id}");
     },
+    /**
+     * Add event hosts
+     *
+     * Add hosts to an event. Creates a free host ticket for each membership without one; existing attendee tickets are switched to the host role. Returns all tickets of the event.
+     *
+     * @param id The id of the event.
+     * @param tickets The `tickets` payload.
+     * @param options Request options (abort signal).
+     */
+    async addEventHosts(id, tickets, options) {
+      return unwrapProp(await client.PUT("/events/v1/{id}/hosts", { params: { path: { id } }, body: { tickets }, signal: options?.signal }), "tickets", "PUT /events/v1/{id}/hosts");
+    },
     /** Cancel an event */
     async cancel(id, options) {
       return unwrapProp(await client.PUT("/events/v1/{id}/cancel", { params: { path: { id } }, signal: options?.signal }), "event", "PUT /events/v1/{id}/cancel");
@@ -1422,6 +1555,40 @@ function createEvents(client, defaults) {
        */
       async get(id, options) {
         return unwrapProp(await client.GET("/events/tickets/v1/{id}", { params: { path: { id } }, signal: options?.signal }), "ticket", "GET /events/tickets/v1/{id}");
+      },
+      /**
+       * Update a ticket
+       *
+       * Update an event ticket. Only the ticket role can be changed.
+       *
+       * @param id The id of the event ticket.
+       * @param ticket The `ticket` payload.
+       * @param options Request options (abort signal).
+       */
+      async update(id, ticket, options) {
+        return unwrapProp(await client.PUT("/events/tickets/v1/{id}", { params: { path: { id } }, body: { ticket }, signal: options?.signal }), "ticket", "PUT /events/tickets/v1/{id}");
+      },
+      /**
+       * Delete a ticket
+       *
+       * Delete an event ticket. Returns the deleted ticket.
+       *
+       * @param id The id of the event ticket.
+       * @param options Request options (abort signal).
+       */
+      async delete(id, options) {
+        return unwrapProp(await client.DELETE("/events/tickets/v1/{id}", { params: { path: { id } }, signal: options?.signal }), "ticket", "DELETE /events/tickets/v1/{id}");
+      },
+      /**
+       * Check in a ticket
+       *
+       * Check in an event ticket. Fails if the ticket is already checked in.
+       *
+       * @param id The id of the event ticket.
+       * @param options Request options (abort signal).
+       */
+      async checkIn(id, options) {
+        return unwrapProp(await client.POST("/events/tickets/v1/{id}/checkin", { params: { path: { id } }, signal: options?.signal }), "ticket", "POST /events/tickets/v1/{id}/checkin");
       }
     }
   };
@@ -1686,6 +1853,54 @@ function createNetworks(client, defaults) {
   };
 }
 
+// src/generated/resources/packages.ts
+function createPackages(client, defaults) {
+  return {
+    /**
+     * Retrieve packages
+     *
+     * Retrieve all packages in the location.
+     */
+    async list(query, options) {
+      return unwrap(await client.GET("/packages/v1", { params: { query }, signal: options?.signal }), "GET /packages/v1");
+    },
+    /**
+     * Retrieve packages — iterates every item across all pages.
+     *
+     * Retrieve all packages in the location.
+     */
+    iterate(query, options) {
+      return paginate(
+        async (nextPageToken) => unwrap(await client.GET("/packages/v1", { params: { query: { ...query, nextPageToken } }, signal: options?.signal }), "GET /packages/v1"),
+        "packages"
+      );
+    },
+    /** Create a package */
+    async create(packageBody, options) {
+      return unwrapProp(await client.POST("/packages/v1", { body: { package: packageBody }, signal: options?.signal }), "package", "POST /packages/v1");
+    },
+    /**
+     * Update a package
+     *
+     * @param packageId The id of the package.
+     * @param packageBody The `package` payload.
+     * @param options Request options (abort signal).
+     */
+    async update(packageId, packageBody, options) {
+      return unwrap(await client.PATCH("/packages/v1/{packageId}", { params: { path: { packageId } }, body: { package: packageBody }, signal: options?.signal }), "PATCH /packages/v1/{packageId}");
+    },
+    /**
+     * Delete a package
+     *
+     * @param packageId The id of the package.
+     * @param options Request options (abort signal).
+     */
+    async delete(packageId, options) {
+      return unwrap(await client.DELETE("/packages/v1/{packageId}", { params: { path: { packageId } }, signal: options?.signal }), "DELETE /packages/v1/{packageId}");
+    }
+  };
+}
+
 // src/generated/resources/plans.ts
 function createPlans(client, defaults) {
   return {
@@ -2477,6 +2692,7 @@ function createResources2(client, defaults) {
     guides: createGuides(client, defaults),
     locations: createLocations(client, defaults),
     networks: createNetworks(client, defaults),
+    packages: createPackages(client, defaults),
     plans: createPlans(client, defaults),
     registrations: createRegistrations(client, defaults),
     resources: createResources(client, defaults),