@izak0s/spacebring-api 16.0.0 → 16.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +20 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +338 -16
- package/dist/index.d.ts +338 -16
- package/dist/index.js +20 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -15,7 +15,7 @@ A fully-typed TypeScript client for the [Spacebring](https://www.spacebring.com)
|
|
|
15
15
|
|
|
16
16
|
## Features
|
|
17
17
|
|
|
18
|
-
- **<!-- coverage -->
|
|
18
|
+
- **<!-- coverage -->220 operations across 22 resource groups<!-- /coverage -->** — the full Spacebring API surface
|
|
19
19
|
- **Auto-generated** from the official OpenAPI spec — types and facade regenerate anytime the spec changes
|
|
20
20
|
- **Nested, discoverable API** — `sb.billing.invoices.pay(id)`, `sb.visitors.visits.checkIn(body)`
|
|
21
21
|
- **Auto-pagination** — every paginated list endpoint has an `iterate()` async generator that walks `nextPageToken` for you
|
package/dist/index.cjs
CHANGED
|
@@ -1118,6 +1118,18 @@ function createCheckins(client, defaults) {
|
|
|
1118
1118
|
async get(checkInId, options) {
|
|
1119
1119
|
return unwrapProp(await client.GET("/check_ins/v1/{checkInId}", { params: { path: { checkInId } }, signal: options?.signal }), "checkIn", "GET /check_ins/v1/{checkInId}");
|
|
1120
1120
|
},
|
|
1121
|
+
/**
|
|
1122
|
+
* Update a check-in
|
|
1123
|
+
*
|
|
1124
|
+
* Change when a customer arrived, or when they left on a check-in that is checked out. Fields left out keep their values. The booking, event ticket, or visit behind the check-in gets the new dates too. The customer and administrators are not notified. With bearer token authentication, the user must be an administrator of the check-in's location.
|
|
1125
|
+
*
|
|
1126
|
+
* @param checkInId The ID of the check-in.
|
|
1127
|
+
* @param checkIn The `checkIn` payload.
|
|
1128
|
+
* @param options Request options (abort signal).
|
|
1129
|
+
*/
|
|
1130
|
+
async update(checkInId, checkIn, options) {
|
|
1131
|
+
return unwrap(await client.PATCH("/check_ins/v1/{checkInId}", { params: { path: { checkInId } }, body: { checkIn }, signal: options?.signal }), "PATCH /check_ins/v1/{checkInId}");
|
|
1132
|
+
},
|
|
1121
1133
|
/**
|
|
1122
1134
|
* Check in
|
|
1123
1135
|
*
|
|
@@ -2130,6 +2142,14 @@ function createPlans(client, defaults) {
|
|
|
2130
2142
|
*/
|
|
2131
2143
|
async delete(planId, options) {
|
|
2132
2144
|
return unwrap(await client.DELETE("/plans/v1/{planId}", { params: { path: { planId } }, signal: options?.signal }), "DELETE /plans/v1/{planId}");
|
|
2145
|
+
},
|
|
2146
|
+
/**
|
|
2147
|
+
* Create a media upload
|
|
2148
|
+
*
|
|
2149
|
+
* 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.
|
|
2150
|
+
*/
|
|
2151
|
+
async createMedia(media, options) {
|
|
2152
|
+
return unwrapProp(await client.POST("/plans/v1/media", { body: { media }, signal: options?.signal }), "media", "POST /plans/v1/media");
|
|
2133
2153
|
}
|
|
2134
2154
|
};
|
|
2135
2155
|
}
|