@izak0s/spacebring-api 12.0.0 → 13.0.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 +11 -18
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +329 -394
- package/dist/index.d.ts +329 -394
- package/dist/index.js +11 -18
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -322,7 +322,11 @@ interface paths {
|
|
|
322
322
|
path?: never;
|
|
323
323
|
cookie?: never;
|
|
324
324
|
};
|
|
325
|
-
|
|
325
|
+
/**
|
|
326
|
+
* Retrieve an alternative currency
|
|
327
|
+
* @description Retrieve an alternative currency. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
328
|
+
*/
|
|
329
|
+
get: operations["getAltCurrency"];
|
|
326
330
|
put?: never;
|
|
327
331
|
post?: never;
|
|
328
332
|
/**
|
|
@@ -1313,7 +1317,7 @@ interface paths {
|
|
|
1313
1317
|
};
|
|
1314
1318
|
/**
|
|
1315
1319
|
* Retrieve coupons
|
|
1316
|
-
* @description Retrieve
|
|
1320
|
+
* @description Retrieve the coupons of a location, or of every location in the network. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
1317
1321
|
*/
|
|
1318
1322
|
get: operations["getCoupons"];
|
|
1319
1323
|
put?: never;
|
|
@@ -2083,18 +2087,10 @@ interface paths {
|
|
|
2083
2087
|
* @description Create a plan. <h3>OAuth</h3>Required scopes: <code>plans</code>
|
|
2084
2088
|
*/
|
|
2085
2089
|
post: operations["createPlan"];
|
|
2086
|
-
|
|
2087
|
-
* Delete plans
|
|
2088
|
-
* @description Delete up to 100 plans at once. Plans that are already deleted are skipped. <h3>OAuth</h3>Required scopes: <code>plans</code>
|
|
2089
|
-
*/
|
|
2090
|
-
delete: operations["deletePlans"];
|
|
2090
|
+
delete?: never;
|
|
2091
2091
|
options?: never;
|
|
2092
2092
|
head?: never;
|
|
2093
|
-
|
|
2094
|
-
* Update plans
|
|
2095
|
-
* @description Turn sign-up on with a type, or off, for up to 100 plans at once. Plans that already have this sign-up are left unchanged. A free plan can't use immediate sign-up. <h3>OAuth</h3>Required scopes: <code>plans</code>
|
|
2096
|
-
*/
|
|
2097
|
-
patch: operations["patchPlans"];
|
|
2093
|
+
patch?: never;
|
|
2098
2094
|
trace?: never;
|
|
2099
2095
|
};
|
|
2100
2096
|
"/plans/v1/{planId}": {
|
|
@@ -3250,6 +3246,35 @@ interface components {
|
|
|
3250
3246
|
message?: string;
|
|
3251
3247
|
type?: string;
|
|
3252
3248
|
};
|
|
3249
|
+
getAltCurrency: {
|
|
3250
|
+
/** @description The alt currency. */
|
|
3251
|
+
altCurrency: {
|
|
3252
|
+
/**
|
|
3253
|
+
* Format: date-time
|
|
3254
|
+
* @description ISO timestamp of when the alt currency was created.
|
|
3255
|
+
*/
|
|
3256
|
+
createDate: string;
|
|
3257
|
+
/** @description ISO 4217 currency code. */
|
|
3258
|
+
currencyCode: string;
|
|
3259
|
+
/** @description Exchange rate relative to the location main currency. */
|
|
3260
|
+
exchangeRate: number;
|
|
3261
|
+
/**
|
|
3262
|
+
* Format: uuid
|
|
3263
|
+
* @description Unique identifier of the alt currency.
|
|
3264
|
+
*/
|
|
3265
|
+
id: string;
|
|
3266
|
+
/**
|
|
3267
|
+
* Format: uuid
|
|
3268
|
+
* @description ID of the location this alt currency belongs to.
|
|
3269
|
+
*/
|
|
3270
|
+
locationRef: string;
|
|
3271
|
+
/**
|
|
3272
|
+
* @description Exchange rate provider when auto-update is enabled.
|
|
3273
|
+
* @enum {string}
|
|
3274
|
+
*/
|
|
3275
|
+
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
|
|
3276
|
+
};
|
|
3277
|
+
};
|
|
3253
3278
|
getBenefitCategories: {
|
|
3254
3279
|
/** @description List of benefit categories. */
|
|
3255
3280
|
categories: {
|
|
@@ -5235,11 +5260,16 @@ interface components {
|
|
|
5235
5260
|
promocode?: {
|
|
5236
5261
|
/** @description Promocode string. */
|
|
5237
5262
|
code: string;
|
|
5238
|
-
/**
|
|
5239
|
-
|
|
5240
|
-
|
|
5241
|
-
|
|
5242
|
-
|
|
5263
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
5264
|
+
expiration?: {
|
|
5265
|
+
/**
|
|
5266
|
+
* Format: date-time
|
|
5267
|
+
* @description ISO timestamp when the promocode expires.
|
|
5268
|
+
*/
|
|
5269
|
+
date?: string;
|
|
5270
|
+
/** @description Whether the promocode has an expiration date. */
|
|
5271
|
+
enabled: boolean;
|
|
5272
|
+
};
|
|
5243
5273
|
/**
|
|
5244
5274
|
* Format: uuid
|
|
5245
5275
|
* @description Promocode ID.
|
|
@@ -5636,11 +5666,16 @@ interface components {
|
|
|
5636
5666
|
promocode?: {
|
|
5637
5667
|
/** @description Promocode string. */
|
|
5638
5668
|
code: string;
|
|
5639
|
-
/**
|
|
5640
|
-
|
|
5641
|
-
|
|
5642
|
-
|
|
5643
|
-
|
|
5669
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
5670
|
+
expiration?: {
|
|
5671
|
+
/**
|
|
5672
|
+
* Format: date-time
|
|
5673
|
+
* @description ISO timestamp when the promocode expires.
|
|
5674
|
+
*/
|
|
5675
|
+
date?: string;
|
|
5676
|
+
/** @description Whether the promocode has an expiration date. */
|
|
5677
|
+
enabled: boolean;
|
|
5678
|
+
};
|
|
5644
5679
|
/**
|
|
5645
5680
|
* Format: uuid
|
|
5646
5681
|
* @description Promocode ID.
|
|
@@ -5976,8 +6011,16 @@ interface components {
|
|
|
5976
6011
|
/** @description Promocode applied. */
|
|
5977
6012
|
promocode?: {
|
|
5978
6013
|
code: string;
|
|
5979
|
-
/**
|
|
5980
|
-
expiration?:
|
|
6014
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
6015
|
+
expiration?: {
|
|
6016
|
+
/**
|
|
6017
|
+
* Format: date-time
|
|
6018
|
+
* @description ISO timestamp when the promocode expires.
|
|
6019
|
+
*/
|
|
6020
|
+
date?: string;
|
|
6021
|
+
/** @description Whether the promocode has an expiration date. */
|
|
6022
|
+
enabled: boolean;
|
|
6023
|
+
};
|
|
5981
6024
|
/** Format: uuid */
|
|
5982
6025
|
id: string;
|
|
5983
6026
|
limitByFirstPurchase?: boolean;
|
|
@@ -6303,8 +6346,16 @@ interface components {
|
|
|
6303
6346
|
/** @description Promocode applied. */
|
|
6304
6347
|
promocode?: {
|
|
6305
6348
|
code: string;
|
|
6306
|
-
/**
|
|
6307
|
-
expiration?:
|
|
6349
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
6350
|
+
expiration?: {
|
|
6351
|
+
/**
|
|
6352
|
+
* Format: date-time
|
|
6353
|
+
* @description ISO timestamp when the promocode expires.
|
|
6354
|
+
*/
|
|
6355
|
+
date?: string;
|
|
6356
|
+
/** @description Whether the promocode has an expiration date. */
|
|
6357
|
+
enabled: boolean;
|
|
6358
|
+
};
|
|
6308
6359
|
/** Format: uuid */
|
|
6309
6360
|
id: string;
|
|
6310
6361
|
limitByFirstPurchase?: boolean;
|
|
@@ -7614,11 +7665,11 @@ interface components {
|
|
|
7614
7665
|
*/
|
|
7615
7666
|
id: string;
|
|
7616
7667
|
/** @description First name of the user. */
|
|
7617
|
-
name
|
|
7668
|
+
name?: string;
|
|
7618
7669
|
/** @description Profile photo URL. */
|
|
7619
7670
|
photoUrl: string | null;
|
|
7620
7671
|
/** @description Surname of the user. */
|
|
7621
|
-
surname
|
|
7672
|
+
surname?: string;
|
|
7622
7673
|
};
|
|
7623
7674
|
};
|
|
7624
7675
|
/**
|
|
@@ -7841,6 +7892,8 @@ interface components {
|
|
|
7841
7892
|
* @enum {string}
|
|
7842
7893
|
*/
|
|
7843
7894
|
ticketAvailability: "soldOut" | "limited" | "available";
|
|
7895
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omitted when unlimited. */
|
|
7896
|
+
ticketsPerAttendee?: number;
|
|
7844
7897
|
/** @description Display name of the event. */
|
|
7845
7898
|
title: string;
|
|
7846
7899
|
/** @description Venue name or address within the location. */
|
|
@@ -8065,15 +8118,6 @@ interface components {
|
|
|
8065
8118
|
*/
|
|
8066
8119
|
type?: "company" | "user";
|
|
8067
8120
|
};
|
|
8068
|
-
location: {
|
|
8069
|
-
/**
|
|
8070
|
-
* Format: uuid
|
|
8071
|
-
* @description ID of the location.
|
|
8072
|
-
*/
|
|
8073
|
-
id: string;
|
|
8074
|
-
/** @description Display name of the location. */
|
|
8075
|
-
title: string;
|
|
8076
|
-
};
|
|
8077
8121
|
};
|
|
8078
8122
|
/** @description Invoice method details. */
|
|
8079
8123
|
invoice?: {
|
|
@@ -8138,15 +8182,6 @@ interface components {
|
|
|
8138
8182
|
};
|
|
8139
8183
|
/** @description Human-readable label of the payment method (e.g. 'Visa 4242'). */
|
|
8140
8184
|
label?: string;
|
|
8141
|
-
location: {
|
|
8142
|
-
/**
|
|
8143
|
-
* Format: uuid
|
|
8144
|
-
* @description ID of the location.
|
|
8145
|
-
*/
|
|
8146
|
-
id: string;
|
|
8147
|
-
/** @description Display name of the location. */
|
|
8148
|
-
title: string;
|
|
8149
|
-
};
|
|
8150
8185
|
/** @description Masked payment method identifier. */
|
|
8151
8186
|
mask?: string;
|
|
8152
8187
|
/** @description Payment gateway title. */
|
|
@@ -8256,7 +8291,7 @@ interface components {
|
|
|
8256
8291
|
* @description Payment type.
|
|
8257
8292
|
* @enum {string}
|
|
8258
8293
|
*/
|
|
8259
|
-
type: "authorizenet" | "credits" | "external" | "flow" | "fondy" | "freedompay" | "hyperpay" | "invoice" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
8294
|
+
type: "authorizenet" | "credits" | "external" | "flow" | "fondy" | "freedompay" | "hyperpay" | "invoice" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
8260
8295
|
};
|
|
8261
8296
|
/** @description Number of tickets included in this purchase. */
|
|
8262
8297
|
quantity: number;
|
|
@@ -9902,14 +9937,14 @@ interface components {
|
|
|
9902
9937
|
* @enum {string}
|
|
9903
9938
|
*/
|
|
9904
9939
|
bookingUnit: "hour" | "day";
|
|
9905
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
9940
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, users can book it up to its start and any time ahead. */
|
|
9906
9941
|
bookingWindow: {
|
|
9907
9942
|
/**
|
|
9908
9943
|
* @description How far ahead users can book the resource.
|
|
9909
9944
|
* @enum {string}
|
|
9910
9945
|
*/
|
|
9911
9946
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
9912
|
-
/** @description Whether the resource
|
|
9947
|
+
/** @description Whether bookings of the resource are limited by this booking window. While it is false, users can book it up to its start and any time ahead. */
|
|
9913
9948
|
enabled: boolean;
|
|
9914
9949
|
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
9915
9950
|
minNotice?: number;
|
|
@@ -10606,14 +10641,14 @@ interface components {
|
|
|
10606
10641
|
* @enum {string}
|
|
10607
10642
|
*/
|
|
10608
10643
|
bookingUnit: "hour" | "day";
|
|
10609
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
10644
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, users can book it up to its start and any time ahead. */
|
|
10610
10645
|
bookingWindow: {
|
|
10611
10646
|
/**
|
|
10612
10647
|
* @description How far ahead users can book the resource.
|
|
10613
10648
|
* @enum {string}
|
|
10614
10649
|
*/
|
|
10615
10650
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
10616
|
-
/** @description Whether the resource
|
|
10651
|
+
/** @description Whether bookings of the resource are limited by this booking window. While it is false, users can book it up to its start and any time ahead. */
|
|
10617
10652
|
enabled: boolean;
|
|
10618
10653
|
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
10619
10654
|
minNotice?: number;
|
|
@@ -11817,7 +11852,7 @@ interface components {
|
|
|
11817
11852
|
* @description Payment gateway that processed the charge.
|
|
11818
11853
|
* @enum {string}
|
|
11819
11854
|
*/
|
|
11820
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
11855
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
11821
11856
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
11822
11857
|
label?: string;
|
|
11823
11858
|
/** @description Masked payment method identifier. */
|
|
@@ -12252,7 +12287,7 @@ interface components {
|
|
|
12252
12287
|
* @description Payment gateway that processed the charge.
|
|
12253
12288
|
* @enum {string}
|
|
12254
12289
|
*/
|
|
12255
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12290
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12256
12291
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
12257
12292
|
label?: string;
|
|
12258
12293
|
/** @description Masked payment method identifier. */
|
|
@@ -12899,7 +12934,7 @@ interface components {
|
|
|
12899
12934
|
* @description Payment gateway that processed the charge.
|
|
12900
12935
|
* @enum {string}
|
|
12901
12936
|
*/
|
|
12902
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12937
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12903
12938
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
12904
12939
|
label?: string;
|
|
12905
12940
|
/** @description Masked payment method identifier. */
|
|
@@ -13334,7 +13369,7 @@ interface components {
|
|
|
13334
13369
|
* @description Payment gateway that processed the charge.
|
|
13335
13370
|
* @enum {string}
|
|
13336
13371
|
*/
|
|
13337
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
13372
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
13338
13373
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
13339
13374
|
label?: string;
|
|
13340
13375
|
/** @description Masked payment method identifier. */
|
|
@@ -14508,7 +14543,7 @@ interface components {
|
|
|
14508
14543
|
* @description Payment gateway type.
|
|
14509
14544
|
* @enum {string}
|
|
14510
14545
|
*/
|
|
14511
|
-
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
14546
|
+
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
14512
14547
|
};
|
|
14513
14548
|
/**
|
|
14514
14549
|
* @description Payment method type.
|
|
@@ -15057,7 +15092,7 @@ interface components {
|
|
|
15057
15092
|
* @description Payment gateway type.
|
|
15058
15093
|
* @enum {string}
|
|
15059
15094
|
*/
|
|
15060
|
-
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
15095
|
+
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
15061
15096
|
};
|
|
15062
15097
|
/**
|
|
15063
15098
|
* @description Payment method type.
|
|
@@ -17321,7 +17356,7 @@ interface components {
|
|
|
17321
17356
|
/** @description Profile image URL of the Lem AI assistant. */
|
|
17322
17357
|
photoUrl: string;
|
|
17323
17358
|
};
|
|
17324
|
-
/** @description Membership of the user who performed the action. */
|
|
17359
|
+
/** @description Membership of the user who performed the action. Holds only an empty user when no membership performed it, such as a Lem AI reply. */
|
|
17325
17360
|
membership?: {
|
|
17326
17361
|
/**
|
|
17327
17362
|
* Format: uuid
|
|
@@ -17352,6 +17387,9 @@ interface components {
|
|
|
17352
17387
|
/** @description Surname of the user. */
|
|
17353
17388
|
surname?: string | null;
|
|
17354
17389
|
};
|
|
17390
|
+
} | {
|
|
17391
|
+
/** @description Empty user. */
|
|
17392
|
+
user: Record<string, never>;
|
|
17355
17393
|
};
|
|
17356
17394
|
/**
|
|
17357
17395
|
* Format: uuid
|
|
@@ -22309,7 +22347,7 @@ interface components {
|
|
|
22309
22347
|
/** @description Location where the visit takes place. */
|
|
22310
22348
|
location: {
|
|
22311
22349
|
/** @description Street address of the location. */
|
|
22312
|
-
address?: string;
|
|
22350
|
+
address?: string | null;
|
|
22313
22351
|
/**
|
|
22314
22352
|
* Format: uuid
|
|
22315
22353
|
* @description Unique identifier of the location.
|
|
@@ -22814,7 +22852,7 @@ interface components {
|
|
|
22814
22852
|
* @description Payment gateway provider.
|
|
22815
22853
|
* @enum {string}
|
|
22816
22854
|
*/
|
|
22817
|
-
gateway: "authorizenet" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22855
|
+
gateway: "authorizenet" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22818
22856
|
/**
|
|
22819
22857
|
* Format: uuid
|
|
22820
22858
|
* @description ID of the saved payment method.
|
|
@@ -22842,7 +22880,7 @@ interface components {
|
|
|
22842
22880
|
* @description Payment gateway type.
|
|
22843
22881
|
* @enum {string}
|
|
22844
22882
|
*/
|
|
22845
|
-
type: "authorizenet" | "external" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22883
|
+
type: "authorizenet" | "external" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22846
22884
|
};
|
|
22847
22885
|
/** @description Whether the user has accepted the payment terms. */
|
|
22848
22886
|
termsConsent?: boolean;
|
|
@@ -23675,6 +23713,8 @@ interface components {
|
|
|
23675
23713
|
* @description ISO timestamp of when the event starts.
|
|
23676
23714
|
*/
|
|
23677
23715
|
startDate: string;
|
|
23716
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omit it for unlimited. */
|
|
23717
|
+
ticketsPerAttendee?: number;
|
|
23678
23718
|
/** @description Display name of the event. */
|
|
23679
23719
|
title: string;
|
|
23680
23720
|
/** @description Venue name or address within the location. */
|
|
@@ -23767,6 +23807,8 @@ interface components {
|
|
|
23767
23807
|
* @description ISO timestamp of when the event starts.
|
|
23768
23808
|
*/
|
|
23769
23809
|
startDate: string;
|
|
23810
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omit it for unlimited. */
|
|
23811
|
+
ticketsPerAttendee?: number;
|
|
23770
23812
|
/** @description Display name of the event. */
|
|
23771
23813
|
title: string;
|
|
23772
23814
|
/** @description Venue name or address within the location. */
|
|
@@ -24249,48 +24291,10 @@ interface components {
|
|
|
24249
24291
|
};
|
|
24250
24292
|
};
|
|
24251
24293
|
};
|
|
24252
|
-
deletePlans: {
|
|
24253
|
-
content: {
|
|
24254
|
-
"application/json": {
|
|
24255
|
-
/** @description Array of IDs of plans to delete. Up to 100 per request. */
|
|
24256
|
-
planIds: string[];
|
|
24257
|
-
};
|
|
24258
|
-
};
|
|
24259
|
-
};
|
|
24260
|
-
patchPlans: {
|
|
24261
|
-
content: {
|
|
24262
|
-
"application/json": {
|
|
24263
|
-
/** @description Plans to update and the fields to set on each of them. */
|
|
24264
|
-
plans: {
|
|
24265
|
-
/** @description IDs of the plans to update. Up to 100 per request. */
|
|
24266
|
-
ids: string[];
|
|
24267
|
-
/** @description Self sign-up settings to set on every plan. */
|
|
24268
|
-
selfSignup: {
|
|
24269
|
-
/**
|
|
24270
|
-
* @description Turn self sign-up on.
|
|
24271
|
-
* @enum {boolean}
|
|
24272
|
-
*/
|
|
24273
|
-
enabled: true;
|
|
24274
|
-
/**
|
|
24275
|
-
* @description Self sign-up flow type. immediate: customers subscribe at once. request: customers apply and an admin approves.
|
|
24276
|
-
* @enum {string}
|
|
24277
|
-
*/
|
|
24278
|
-
type: "immediate" | "request";
|
|
24279
|
-
} | {
|
|
24280
|
-
/**
|
|
24281
|
-
* @description Turn self sign-up off. Each plan keeps its sign-up type.
|
|
24282
|
-
* @enum {boolean}
|
|
24283
|
-
*/
|
|
24284
|
-
enabled: false;
|
|
24285
|
-
};
|
|
24286
|
-
};
|
|
24287
|
-
};
|
|
24288
|
-
};
|
|
24289
|
-
};
|
|
24290
24294
|
updatePlan: {
|
|
24291
24295
|
content: {
|
|
24292
24296
|
"application/json": {
|
|
24293
|
-
/** @description Plan fields to
|
|
24297
|
+
/** @description Plan fields to change. Omitted fields keep their current values. */
|
|
24294
24298
|
plan: {
|
|
24295
24299
|
/** @description Third-party access integrations. */
|
|
24296
24300
|
access?: {
|
|
@@ -24318,15 +24322,9 @@ interface components {
|
|
|
24318
24322
|
/** Format: uuid */
|
|
24319
24323
|
id: string;
|
|
24320
24324
|
}[];
|
|
24321
|
-
/**
|
|
24322
|
-
* @description Number of billing cycles the member is committed to.
|
|
24323
|
-
* @default 0
|
|
24324
|
-
*/
|
|
24325
|
+
/** @description Number of billing cycles the member is committed to. */
|
|
24325
24326
|
commitmentCycles?: number;
|
|
24326
|
-
/**
|
|
24327
|
-
* @description Credits included in the plan.
|
|
24328
|
-
* @default 0
|
|
24329
|
-
*/
|
|
24327
|
+
/** @description Credits included in the plan. */
|
|
24330
24328
|
credits?: number;
|
|
24331
24329
|
/** @description Custom tax settings. */
|
|
24332
24330
|
customTax?: {
|
|
@@ -24335,15 +24333,9 @@ interface components {
|
|
|
24335
24333
|
/** @description Custom tax rate percentage. */
|
|
24336
24334
|
rate: number;
|
|
24337
24335
|
};
|
|
24338
|
-
/**
|
|
24339
|
-
* @description Number of day passes included in the plan.
|
|
24340
|
-
* @default 0
|
|
24341
|
-
*/
|
|
24336
|
+
/** @description Number of day passes included in the plan. */
|
|
24342
24337
|
dayPasses?: number;
|
|
24343
|
-
/**
|
|
24344
|
-
* @description Description of the plan.
|
|
24345
|
-
* @default
|
|
24346
|
-
*/
|
|
24338
|
+
/** @description Description of the plan. */
|
|
24347
24339
|
description?: string;
|
|
24348
24340
|
/**
|
|
24349
24341
|
* @deprecated
|
|
@@ -24363,12 +24355,7 @@ interface components {
|
|
|
24363
24355
|
/** @description Discount percentage for shop products. */
|
|
24364
24356
|
shop: number;
|
|
24365
24357
|
};
|
|
24366
|
-
/**
|
|
24367
|
-
* @description Resources and benefits exclusively available to members on this plan.
|
|
24368
|
-
* @default {
|
|
24369
|
-
* "resourceRefs": []
|
|
24370
|
-
* }
|
|
24371
|
-
*/
|
|
24358
|
+
/** @description Resources and benefits exclusively available to members on this plan. */
|
|
24372
24359
|
exclusiveAccess?: {
|
|
24373
24360
|
/** @description Benefit IDs with exclusive access for this plan. */
|
|
24374
24361
|
benefitRefs?: string[];
|
|
@@ -24414,10 +24401,7 @@ interface components {
|
|
|
24414
24401
|
*/
|
|
24415
24402
|
type: "immediate" | "request";
|
|
24416
24403
|
};
|
|
24417
|
-
/**
|
|
24418
|
-
* @description One-time setup fee.
|
|
24419
|
-
* @default 0
|
|
24420
|
-
*/
|
|
24404
|
+
/** @description One-time setup fee. */
|
|
24421
24405
|
setupFee?: number;
|
|
24422
24406
|
/** @description Display name of the plan. */
|
|
24423
24407
|
title?: string;
|
|
@@ -24454,14 +24438,14 @@ interface components {
|
|
|
24454
24438
|
* @enum {string}
|
|
24455
24439
|
*/
|
|
24456
24440
|
bookingUnit?: "hour" | "day";
|
|
24457
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
24441
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, users can book it up to its start and any time ahead, and the resource keeps its own values for when it is enabled again. Administrators are not limited by it. */
|
|
24458
24442
|
bookingWindow?: {
|
|
24459
24443
|
/**
|
|
24460
|
-
* @description How far ahead users can book the resource
|
|
24444
|
+
* @description How far ahead users can book the resource. Required while enabled is true.
|
|
24461
24445
|
* @enum {string}
|
|
24462
24446
|
*/
|
|
24463
24447
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24464
|
-
/** @description Whether the resource
|
|
24448
|
+
/** @description Whether bookings of the resource are limited by this booking window. While it is false, users can book it up to its start and any time ahead. */
|
|
24465
24449
|
enabled: boolean;
|
|
24466
24450
|
/** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
|
|
24467
24451
|
minNotice?: number;
|
|
@@ -24854,7 +24838,7 @@ interface components {
|
|
|
24854
24838
|
customerRef?: string;
|
|
24855
24839
|
/**
|
|
24856
24840
|
* Format: date-time
|
|
24857
|
-
* @description ISO timestamp
|
|
24841
|
+
* @description ISO timestamp of the day the assignment ends. The assignment lasts through that day and ends at 23:59 in the time zone of the location. Omit for an open-ended assignment.
|
|
24858
24842
|
*/
|
|
24859
24843
|
endDate?: string;
|
|
24860
24844
|
/** @description Whether the assignment grants access to the entire resource. */
|
|
@@ -24881,7 +24865,7 @@ interface components {
|
|
|
24881
24865
|
assignment: {
|
|
24882
24866
|
/**
|
|
24883
24867
|
* Format: date-time
|
|
24884
|
-
* @description ISO timestamp
|
|
24868
|
+
* @description ISO timestamp of the day the assignment ends. The assignment lasts through that day and ends at 23:59 in the time zone of the location. Send null to make the assignment open-ended.
|
|
24885
24869
|
*/
|
|
24886
24870
|
endDate?: string | null;
|
|
24887
24871
|
/** @description Whether the assignment grants access to the entire resource. */
|
|
@@ -24947,14 +24931,14 @@ interface components {
|
|
|
24947
24931
|
* @enum {string}
|
|
24948
24932
|
*/
|
|
24949
24933
|
bookingUnit?: "hour" | "day";
|
|
24950
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
24934
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, users can book it up to its start and any time ahead, and the resource keeps its own values for when it is enabled again. Administrators are not limited by it. */
|
|
24951
24935
|
bookingWindow?: {
|
|
24952
24936
|
/**
|
|
24953
|
-
* @description How far ahead users can book the resource
|
|
24937
|
+
* @description How far ahead users can book the resource. Required while enabled is true.
|
|
24954
24938
|
* @enum {string}
|
|
24955
24939
|
*/
|
|
24956
24940
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24957
|
-
/** @description Whether the resource
|
|
24941
|
+
/** @description Whether bookings of the resource are limited by this booking window. While it is false, users can book it up to its start and any time ahead. */
|
|
24958
24942
|
enabled: boolean;
|
|
24959
24943
|
/** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
|
|
24960
24944
|
minNotice?: number;
|
|
@@ -26573,7 +26557,7 @@ interface components {
|
|
|
26573
26557
|
type?: "access" | "accountAndBilling" | "bookings" | "cleaning" | "discriminationAndHarassment" | "internet" | "mailAndPackages" | "noiseAndAcoustics" | "offensiveOrObjectionableContent" | "other" | "printing" | "repairAndMaintenance" | "temperatureAndVentilation" | "websiteAndApp";
|
|
26574
26558
|
/**
|
|
26575
26559
|
* Format: uuid
|
|
26576
|
-
* @description ID of the user requesting the ticket. Defaults to the authenticated user when omitted.
|
|
26560
|
+
* @description ID of the user requesting the ticket. Defaults to the authenticated user when omitted, and is required with Basic authentication.
|
|
26577
26561
|
*/
|
|
26578
26562
|
userRefRequester?: string;
|
|
26579
26563
|
};
|
|
@@ -26824,7 +26808,7 @@ interface components {
|
|
|
26824
26808
|
* @description Payment gateway provider. Only gateways that support saved payment methods can be charged.
|
|
26825
26809
|
* @enum {string}
|
|
26826
26810
|
*/
|
|
26827
|
-
gateway: "hyperpay" | "mollie" | "paypal" | "plata" | "stripe" | "tap" | "wayforpay";
|
|
26811
|
+
gateway: "hyperpay" | "mollie" | "paypal" | "paytabs" | "plata" | "stripe" | "tap" | "wayforpay";
|
|
26828
26812
|
/**
|
|
26829
26813
|
* Format: uuid
|
|
26830
26814
|
* @description ID of the saved payment method to charge.
|
|
@@ -27066,6 +27050,41 @@ interface operations {
|
|
|
27066
27050
|
};
|
|
27067
27051
|
};
|
|
27068
27052
|
};
|
|
27053
|
+
getAltCurrency: {
|
|
27054
|
+
parameters: {
|
|
27055
|
+
query?: never;
|
|
27056
|
+
header?: {
|
|
27057
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
27058
|
+
"spacebring-network-id"?: string;
|
|
27059
|
+
};
|
|
27060
|
+
path: {
|
|
27061
|
+
/** @description The id of the alternative currency */
|
|
27062
|
+
id: string;
|
|
27063
|
+
};
|
|
27064
|
+
cookie?: never;
|
|
27065
|
+
};
|
|
27066
|
+
requestBody?: never;
|
|
27067
|
+
responses: {
|
|
27068
|
+
/** @description OK */
|
|
27069
|
+
200: {
|
|
27070
|
+
headers: {
|
|
27071
|
+
[name: string]: unknown;
|
|
27072
|
+
};
|
|
27073
|
+
content: {
|
|
27074
|
+
"application/json": components["schemas"]["getAltCurrency"];
|
|
27075
|
+
};
|
|
27076
|
+
};
|
|
27077
|
+
/** @description Bad Request */
|
|
27078
|
+
400: {
|
|
27079
|
+
headers: {
|
|
27080
|
+
[name: string]: unknown;
|
|
27081
|
+
};
|
|
27082
|
+
content: {
|
|
27083
|
+
"application/json": components["schemas"]["responseError"];
|
|
27084
|
+
};
|
|
27085
|
+
};
|
|
27086
|
+
};
|
|
27087
|
+
};
|
|
27069
27088
|
deleteAltCurrency: {
|
|
27070
27089
|
parameters: {
|
|
27071
27090
|
query?: never;
|
|
@@ -27134,9 +27153,9 @@ interface operations {
|
|
|
27134
27153
|
};
|
|
27135
27154
|
getBenefitCategories: {
|
|
27136
27155
|
parameters: {
|
|
27137
|
-
query
|
|
27138
|
-
/** @description UUID of the location whose benefit categories to list. */
|
|
27139
|
-
locationRef
|
|
27156
|
+
query?: {
|
|
27157
|
+
/** @description UUID of the location whose benefit categories to list, in member-facing order. Omit to list the categories of every location of the network. */
|
|
27158
|
+
locationRef?: string;
|
|
27140
27159
|
};
|
|
27141
27160
|
header?: {
|
|
27142
27161
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -27315,7 +27334,7 @@ interface operations {
|
|
|
27315
27334
|
featured?: boolean;
|
|
27316
27335
|
/** @description Maximum number of benefits per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
27317
27336
|
limit?: number;
|
|
27318
|
-
/** @description UUID of the location. */
|
|
27337
|
+
/** @description UUID of the location. Omit both locationRef and categoryRef to list benefits across every location of the network. */
|
|
27319
27338
|
locationRef?: string;
|
|
27320
27339
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
27321
27340
|
nextPageToken?: string;
|
|
@@ -27542,7 +27561,7 @@ interface operations {
|
|
|
27542
27561
|
customerRef?: string;
|
|
27543
27562
|
/** @description Maximum number of applications per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
27544
27563
|
limit?: number;
|
|
27545
|
-
/** @description UUID of the location. */
|
|
27564
|
+
/** @description UUID of the location. Omit locationRef, benefitRef, customerRef and userRef to list applications across every location of the network. */
|
|
27546
27565
|
locationRef?: string;
|
|
27547
27566
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
27548
27567
|
nextPageToken?: string;
|
|
@@ -27672,15 +27691,7 @@ interface operations {
|
|
|
27672
27691
|
nextPageToken?: string;
|
|
27673
27692
|
/** @description Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
|
|
27674
27693
|
q?: string;
|
|
27675
|
-
/**
|
|
27676
|
-
* @description Filter by invoice status. Comma-separated values, e.g. `draft,issued`.
|
|
27677
|
-
*
|
|
27678
|
-
* Supported values:
|
|
27679
|
-
* - **draft** — created but not sent
|
|
27680
|
-
* - **issued** — sent to the customer but unpaid
|
|
27681
|
-
* - **paid** — fully paid
|
|
27682
|
-
* - **voided** — cancelled and no longer valid
|
|
27683
|
-
*/
|
|
27694
|
+
/** @description Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
27684
27695
|
status?: string;
|
|
27685
27696
|
};
|
|
27686
27697
|
header?: {
|
|
@@ -28078,21 +28089,13 @@ interface operations {
|
|
|
28078
28089
|
locationRef?: string;
|
|
28079
28090
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28080
28091
|
nextPageToken?: string;
|
|
28081
|
-
/**
|
|
28082
|
-
* @description Filter by the status of the invoice the item is on. Items not on an invoice are excluded. Comma-separated values, e.g. `draft,issued`.
|
|
28083
|
-
*
|
|
28084
|
-
* Supported values:
|
|
28085
|
-
* - **draft** — created but not sent
|
|
28086
|
-
* - **issued** — sent to the customer but unpaid
|
|
28087
|
-
* - **paid** — fully paid
|
|
28088
|
-
* - **voided** — cancelled and no longer valid
|
|
28089
|
-
*/
|
|
28092
|
+
/** @description Filter by the status of the invoice the item is on: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Items not on an invoice are excluded. Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
28090
28093
|
status?: string;
|
|
28091
28094
|
/** @description UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
|
|
28092
28095
|
invoiceRef?: string;
|
|
28093
28096
|
/** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
28094
28097
|
pending?: "true" | "false";
|
|
28095
|
-
/** @description Filter by invoice item type. Comma-separated
|
|
28098
|
+
/** @description Filter by invoice item type. Comma-separated, one or more of: creditPackage, custom, booking, eventTicket, subscription, order. */
|
|
28096
28099
|
type?: string;
|
|
28097
28100
|
};
|
|
28098
28101
|
header?: {
|
|
@@ -28356,13 +28359,7 @@ interface operations {
|
|
|
28356
28359
|
locationRef?: string;
|
|
28357
28360
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28358
28361
|
nextPageToken?: string;
|
|
28359
|
-
/**
|
|
28360
|
-
* @description Filter by credit note status. Comma-separated values, e.g. `issued,voided`.
|
|
28361
|
-
*
|
|
28362
|
-
* Supported values:
|
|
28363
|
-
* - **issued** — active credit note
|
|
28364
|
-
* - **voided** — cancelled and no longer valid
|
|
28365
|
-
*/
|
|
28362
|
+
/** @description Filter by credit note status: issued (in effect) or voided (cancelled and no longer valid). Comma-separated, one or more of: issued, voided. */
|
|
28366
28363
|
status?: string;
|
|
28367
28364
|
};
|
|
28368
28365
|
header?: {
|
|
@@ -29326,15 +29323,15 @@ interface operations {
|
|
|
29326
29323
|
"createDate[gte]"?: string;
|
|
29327
29324
|
/** @description Filter contracts created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
29328
29325
|
"createDate[lte]"?: string;
|
|
29329
|
-
/** @description UUID of the customer (membership or company).
|
|
29326
|
+
/** @description UUID of the customer (membership or company). When set, returns only that customer's contracts. */
|
|
29330
29327
|
customerRef?: string;
|
|
29331
29328
|
/** @description Maximum number of contracts per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29332
29329
|
limit?: number;
|
|
29333
|
-
/** @description UUID of the location.
|
|
29330
|
+
/** @description UUID of the location. When set, returns contracts in that location. Omit both locationRef and customerRef to list contracts across every location of the network. */
|
|
29334
29331
|
locationRef?: string;
|
|
29335
29332
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29336
29333
|
nextPageToken?: string;
|
|
29337
|
-
/** @description Case-insensitive search by contract title
|
|
29334
|
+
/** @description Case-insensitive search by contract title, within customerRef or locationRef when given and across the network otherwise. */
|
|
29338
29335
|
q?: string;
|
|
29339
29336
|
/** @description Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
|
|
29340
29337
|
status?: string;
|
|
@@ -29674,11 +29671,11 @@ interface operations {
|
|
|
29674
29671
|
};
|
|
29675
29672
|
getTemplates: {
|
|
29676
29673
|
parameters: {
|
|
29677
|
-
query
|
|
29674
|
+
query?: {
|
|
29678
29675
|
/** @description Maximum number of templates per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29679
29676
|
limit?: number;
|
|
29680
|
-
/** @description UUID of the location. */
|
|
29681
|
-
locationRef
|
|
29677
|
+
/** @description UUID of the location whose templates to list. Omit to list templates across every location of the network. */
|
|
29678
|
+
locationRef?: string;
|
|
29682
29679
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29683
29680
|
nextPageToken?: string;
|
|
29684
29681
|
};
|
|
@@ -29931,15 +29928,15 @@ interface operations {
|
|
|
29931
29928
|
};
|
|
29932
29929
|
getCoupons: {
|
|
29933
29930
|
parameters: {
|
|
29934
|
-
query
|
|
29935
|
-
/** @description
|
|
29936
|
-
locationRef: string;
|
|
29937
|
-
/** @description Comma-separated list of coupon types to filter by */
|
|
29938
|
-
type?: "creditPackages" | "desks" | "equipment" | "events" | "products" | "rooms" | "subscriptionItems";
|
|
29939
|
-
/** @description The number of coupons to retrieve. Default: 25 */
|
|
29931
|
+
query?: {
|
|
29932
|
+
/** @description Maximum number of coupons per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29940
29933
|
limit?: number;
|
|
29941
|
-
/** @description
|
|
29942
|
-
|
|
29934
|
+
/** @description UUID of the location whose coupons to list. Omit to list coupons across every location of the network. */
|
|
29935
|
+
locationRef?: string;
|
|
29936
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
29937
|
+
nextPageToken?: string;
|
|
29938
|
+
/** @description Filter by the product types a coupon applies to; a coupon matches when it applies to any of them. Comma-separated, one or more of: roomBookings, eventSpaceBookings, conferenceRoomBookings, meetingRoomBookings, phoneBoothBookings, stationBookings, studioBookings, hotDeskBookings, dedicatedDeskBookings, officeBookings, parkingBookings, equipmentBookings, eventTickets, shopProducts, packages, subscriptionItems. */
|
|
29939
|
+
type?: string;
|
|
29943
29940
|
};
|
|
29944
29941
|
header?: {
|
|
29945
29942
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -30114,10 +30111,10 @@ interface operations {
|
|
|
30114
30111
|
getPromocodes: {
|
|
30115
30112
|
parameters: {
|
|
30116
30113
|
query?: {
|
|
30117
|
-
/** @description
|
|
30118
|
-
locationRef?: string;
|
|
30119
|
-
/** @description The id of the coupon. At least one of locationRef or couponRef is required */
|
|
30114
|
+
/** @description UUID of the coupon whose promocodes to list. */
|
|
30120
30115
|
couponRef?: string;
|
|
30116
|
+
/** @description UUID of the location whose promocodes to list. Omit with couponRef to list promocodes across every location of the network. */
|
|
30117
|
+
locationRef?: string;
|
|
30121
30118
|
};
|
|
30122
30119
|
header?: {
|
|
30123
30120
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -30261,14 +30258,14 @@ interface operations {
|
|
|
30261
30258
|
getDiscountRedemptions: {
|
|
30262
30259
|
parameters: {
|
|
30263
30260
|
query?: {
|
|
30264
|
-
/** @description
|
|
30261
|
+
/** @description UUID of the coupon whose redemptions to list. */
|
|
30265
30262
|
couponRef?: string;
|
|
30266
|
-
/** @description
|
|
30267
|
-
promocodeRef?: string;
|
|
30268
|
-
/** @description The number of items to return */
|
|
30263
|
+
/** @description Maximum number of discount redemptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
30269
30264
|
limit?: number;
|
|
30270
|
-
/** @description
|
|
30271
|
-
nextPageToken?:
|
|
30265
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30266
|
+
nextPageToken?: string;
|
|
30267
|
+
/** @description UUID of the promocode whose redemptions to list. */
|
|
30268
|
+
promocodeRef?: string;
|
|
30272
30269
|
};
|
|
30273
30270
|
header?: {
|
|
30274
30271
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -30306,16 +30303,39 @@ interface operations {
|
|
|
30306
30303
|
getEventsByOrganization: {
|
|
30307
30304
|
parameters: {
|
|
30308
30305
|
query: {
|
|
30309
|
-
/** @description
|
|
30310
|
-
|
|
30311
|
-
/** @description
|
|
30306
|
+
/** @description Filter events whose create date is on or after this date (ISO 8601). */
|
|
30307
|
+
"createDate[gte]"?: string;
|
|
30308
|
+
/** @description Filter events whose create date is on or before this date (ISO 8601). */
|
|
30309
|
+
"createDate[lte]"?: string;
|
|
30310
|
+
/** @description Filter events whose end date is after this date (ISO 8601). */
|
|
30311
|
+
"endDate[gt]"?: string;
|
|
30312
|
+
/** @description Filter events whose end date is on or after this date (ISO 8601). */
|
|
30313
|
+
"endDate[gte]"?: string;
|
|
30314
|
+
/** @description Filter events whose end date is before this date (ISO 8601). */
|
|
30315
|
+
"endDate[lt]"?: string;
|
|
30316
|
+
/** @description Filter events whose end date is on or before this date (ISO 8601). */
|
|
30317
|
+
"endDate[lte]"?: string;
|
|
30318
|
+
/** @description Maximum number of events per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
30312
30319
|
limit?: number;
|
|
30313
|
-
/** @description
|
|
30314
|
-
|
|
30315
|
-
/** @description
|
|
30320
|
+
/** @description UUID of the location whose events to list. */
|
|
30321
|
+
locationRef: string;
|
|
30322
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30323
|
+
nextPageToken?: string;
|
|
30324
|
+
/** @description Sort order of events. One of relevance, createDate:asc, createDate:desc, startDate:asc, startDate:desc, endDate:asc, endDate:desc. */
|
|
30316
30325
|
order?: string;
|
|
30326
|
+
/** @description Filter events whose start date is after this date (ISO 8601). */
|
|
30327
|
+
"startDate[gt]"?: string;
|
|
30328
|
+
/** @description Filter events whose start date is on or after this date (ISO 8601). */
|
|
30329
|
+
"startDate[gte]"?: string;
|
|
30330
|
+
/** @description Filter events whose start date is before this date (ISO 8601). */
|
|
30331
|
+
"startDate[lt]"?: string;
|
|
30332
|
+
/** @description Filter events whose start date is on or before this date (ISO 8601). */
|
|
30333
|
+
"startDate[lte]"?: string;
|
|
30334
|
+
};
|
|
30335
|
+
header?: {
|
|
30336
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
30337
|
+
"spacebring-network-id"?: string;
|
|
30317
30338
|
};
|
|
30318
|
-
header?: never;
|
|
30319
30339
|
path?: never;
|
|
30320
30340
|
cookie?: never;
|
|
30321
30341
|
};
|
|
@@ -30660,13 +30680,7 @@ interface operations {
|
|
|
30660
30680
|
locationRef?: string;
|
|
30661
30681
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30662
30682
|
nextPageToken?: string;
|
|
30663
|
-
/**
|
|
30664
|
-
* @description Filter by event ticket status. Comma-separated values, e.g. `active,canceled`. Defaults to `active` when omitted.
|
|
30665
|
-
*
|
|
30666
|
-
* Supported values:
|
|
30667
|
-
* - **active** — the ticket is valid
|
|
30668
|
-
* - **canceled** — the ticket was deleted
|
|
30669
|
-
*/
|
|
30683
|
+
/** @description Filter by event ticket status: 'active' the ticket is valid, 'canceled' the ticket was deleted. Defaults to active. Comma-separated, one or more of: active, canceled. */
|
|
30670
30684
|
status?: string;
|
|
30671
30685
|
/** @description UUID of the user whose event tickets to list. */
|
|
30672
30686
|
userRef?: string;
|
|
@@ -31445,11 +31459,11 @@ interface operations {
|
|
|
31445
31459
|
};
|
|
31446
31460
|
getGuides: {
|
|
31447
31461
|
parameters: {
|
|
31448
|
-
query
|
|
31462
|
+
query?: {
|
|
31449
31463
|
/** @description Maximum number of guides per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
31450
31464
|
limit?: number;
|
|
31451
|
-
/** @description UUID of the location whose guides to list. */
|
|
31452
|
-
locationRef
|
|
31465
|
+
/** @description UUID of the location whose guides to list. Omit to list guides across every location of the network. */
|
|
31466
|
+
locationRef?: string;
|
|
31453
31467
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
31454
31468
|
nextPageToken?: string;
|
|
31455
31469
|
};
|
|
@@ -31879,11 +31893,11 @@ interface operations {
|
|
|
31879
31893
|
};
|
|
31880
31894
|
getPackages: {
|
|
31881
31895
|
parameters: {
|
|
31882
|
-
query
|
|
31896
|
+
query?: {
|
|
31883
31897
|
/** @description Maximum number of packages per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
31884
31898
|
limit?: number;
|
|
31885
|
-
/** @description UUID of the location. */
|
|
31886
|
-
locationRef
|
|
31899
|
+
/** @description UUID of the location whose packages to list. Omit to list packages across every location of the network. */
|
|
31900
|
+
locationRef?: string;
|
|
31887
31901
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
31888
31902
|
nextPageToken?: string;
|
|
31889
31903
|
};
|
|
@@ -32021,7 +32035,7 @@ interface operations {
|
|
|
32021
32035
|
entire?: string;
|
|
32022
32036
|
/** @description Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
32023
32037
|
limit?: number;
|
|
32024
|
-
/** @description UUID of the location whose plans to list. */
|
|
32038
|
+
/** @description UUID of the location whose plans to list. Omit to list plans across every location of the network. */
|
|
32025
32039
|
locationRef?: string;
|
|
32026
32040
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
32027
32041
|
nextPageToken?: string;
|
|
@@ -32088,66 +32102,6 @@ interface operations {
|
|
|
32088
32102
|
};
|
|
32089
32103
|
};
|
|
32090
32104
|
};
|
|
32091
|
-
deletePlans: {
|
|
32092
|
-
parameters: {
|
|
32093
|
-
query?: never;
|
|
32094
|
-
header?: {
|
|
32095
|
-
/** @description The id of the network. Required when using bearer token authentication */
|
|
32096
|
-
"spacebring-network-id"?: string;
|
|
32097
|
-
};
|
|
32098
|
-
path?: never;
|
|
32099
|
-
cookie?: never;
|
|
32100
|
-
};
|
|
32101
|
-
requestBody: components["requestBodies"]["deletePlans"];
|
|
32102
|
-
responses: {
|
|
32103
|
-
/** @description No Content */
|
|
32104
|
-
204: {
|
|
32105
|
-
headers: {
|
|
32106
|
-
[name: string]: unknown;
|
|
32107
|
-
};
|
|
32108
|
-
content?: never;
|
|
32109
|
-
};
|
|
32110
|
-
/** @description Bad Request */
|
|
32111
|
-
400: {
|
|
32112
|
-
headers: {
|
|
32113
|
-
[name: string]: unknown;
|
|
32114
|
-
};
|
|
32115
|
-
content: {
|
|
32116
|
-
"application/json": components["schemas"]["responseError"];
|
|
32117
|
-
};
|
|
32118
|
-
};
|
|
32119
|
-
};
|
|
32120
|
-
};
|
|
32121
|
-
patchPlans: {
|
|
32122
|
-
parameters: {
|
|
32123
|
-
query?: never;
|
|
32124
|
-
header?: {
|
|
32125
|
-
/** @description The id of the network. Required when using bearer token authentication */
|
|
32126
|
-
"spacebring-network-id"?: string;
|
|
32127
|
-
};
|
|
32128
|
-
path?: never;
|
|
32129
|
-
cookie?: never;
|
|
32130
|
-
};
|
|
32131
|
-
requestBody: components["requestBodies"]["patchPlans"];
|
|
32132
|
-
responses: {
|
|
32133
|
-
/** @description No Content */
|
|
32134
|
-
204: {
|
|
32135
|
-
headers: {
|
|
32136
|
-
[name: string]: unknown;
|
|
32137
|
-
};
|
|
32138
|
-
content?: never;
|
|
32139
|
-
};
|
|
32140
|
-
/** @description Bad Request */
|
|
32141
|
-
400: {
|
|
32142
|
-
headers: {
|
|
32143
|
-
[name: string]: unknown;
|
|
32144
|
-
};
|
|
32145
|
-
content: {
|
|
32146
|
-
"application/json": components["schemas"]["responseError"];
|
|
32147
|
-
};
|
|
32148
|
-
};
|
|
32149
|
-
};
|
|
32150
|
-
};
|
|
32151
32105
|
getPlan: {
|
|
32152
32106
|
parameters: {
|
|
32153
32107
|
query?: never;
|
|
@@ -32292,14 +32246,14 @@ interface operations {
|
|
|
32292
32246
|
};
|
|
32293
32247
|
getResources: {
|
|
32294
32248
|
parameters: {
|
|
32295
|
-
query
|
|
32249
|
+
query?: {
|
|
32296
32250
|
/** @description Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
32297
32251
|
limit?: number;
|
|
32298
|
-
/** @description UUID of the location whose resources to list. */
|
|
32299
|
-
locationRef
|
|
32252
|
+
/** @description UUID of the location whose resources to list. Omit to list resources across every location of the network. */
|
|
32253
|
+
locationRef?: string;
|
|
32300
32254
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
32301
32255
|
nextPageToken?: string;
|
|
32302
|
-
/** @description
|
|
32256
|
+
/** @description Resource types to filter by, e.g. `room,hotDesk`. Defaults to all bookable types. Comma-separated, one or more of: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. */
|
|
32303
32257
|
type?: string;
|
|
32304
32258
|
/** @description Deprecated. Use type instead. */
|
|
32305
32259
|
types?: string;
|
|
@@ -32723,7 +32677,7 @@ interface operations {
|
|
|
32723
32677
|
includeDeleted?: string;
|
|
32724
32678
|
/** @description Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
32725
32679
|
limit?: number;
|
|
32726
|
-
/** @description UUID of the location whose bookings to list.
|
|
32680
|
+
/** @description UUID of the location whose bookings to list. Omit to list bookings across every location of the network. */
|
|
32727
32681
|
locationRef?: string;
|
|
32728
32682
|
/** @description Deprecated. Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
32729
32683
|
membershipRefOwner?: string;
|
|
@@ -32731,19 +32685,19 @@ interface operations {
|
|
|
32731
32685
|
nextPageToken?: string;
|
|
32732
32686
|
/** @description Sort order as `<field>:<direction>`, where field is startDate, endDate, createDate or deleteDate and direction is asc or desc. deleteDate lists only cancelled bookings, by when they were cancelled, and cannot be combined with singleBookings. Defaults to startDate:asc when a startDate filter is given, endDate:asc when only an endDate filter is given, and createDate:desc otherwise. */
|
|
32733
32687
|
order?: string;
|
|
32734
|
-
/** @description UUID of the resource whose bookings to list.
|
|
32688
|
+
/** @description UUID of the resource whose bookings to list. */
|
|
32735
32689
|
resourceRef?: string;
|
|
32736
32690
|
/** @description Set to "true" to expand repeating bookings into single occurrences. */
|
|
32737
32691
|
singleBookings?: string;
|
|
32738
32692
|
/** @description Deprecated. Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
32739
32693
|
startDate?: string;
|
|
32740
|
-
/** @description
|
|
32694
|
+
/** @description Booking statuses to filter by, e.g. `confirmed,canceled`. Defaults to tentative and confirmed, or to canceled when ordering by deleteDate. Comma-separated, one or more of: tentative, confirmed, canceled. */
|
|
32741
32695
|
status?: string;
|
|
32742
|
-
/** @description
|
|
32696
|
+
/** @description Resource types of the booked resources to filter by, e.g. `room,hotDesk`. Defaults to all bookable types. Comma-separated, one or more of: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. */
|
|
32743
32697
|
type?: string;
|
|
32744
|
-
/** @description UUID of the user whose bookings to list, both made and attended.
|
|
32698
|
+
/** @description UUID of the user whose bookings to list, both made and attended. Without locationRef or resourceRef, lists the user's bookings across every location of the network. Cannot be combined with customerRef, companyRefOwner, or userRefOwner. */
|
|
32745
32699
|
userRef?: string;
|
|
32746
|
-
/** @description UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Cannot be combined with customerRef, companyRefOwner, or userRef. */
|
|
32700
|
+
/** @description UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Without locationRef or resourceRef, lists the user's own bookings across every location of the network. Cannot be combined with customerRef, companyRefOwner, or userRef. */
|
|
32747
32701
|
userRefOwner?: string;
|
|
32748
32702
|
/** @description Deprecated. Use type instead. */
|
|
32749
32703
|
types?: string;
|
|
@@ -33091,7 +33045,7 @@ interface operations {
|
|
|
33091
33045
|
query?: {
|
|
33092
33046
|
/** @description UUID of the shop category. */
|
|
33093
33047
|
categoryRef?: string;
|
|
33094
|
-
/** @description
|
|
33048
|
+
/** @description Product UUIDs to get, up to 25 per request. Comma-separated, one or more UUIDs. */
|
|
33095
33049
|
id?: string;
|
|
33096
33050
|
/** @description Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
33097
33051
|
limit?: number;
|
|
@@ -33315,7 +33269,7 @@ interface operations {
|
|
|
33315
33269
|
getOrders: {
|
|
33316
33270
|
parameters: {
|
|
33317
33271
|
query?: {
|
|
33318
|
-
/** @description
|
|
33272
|
+
/** @description Filter by the shop categories of the products in the order. Comma-separated, one or more UUIDs. */
|
|
33319
33273
|
categoryRef?: string;
|
|
33320
33274
|
/** @description Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
|
|
33321
33275
|
"createDate[gte]"?: string;
|
|
@@ -33329,17 +33283,9 @@ interface operations {
|
|
|
33329
33283
|
locationRef?: string;
|
|
33330
33284
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
33331
33285
|
nextPageToken?: string;
|
|
33332
|
-
/** @description
|
|
33286
|
+
/** @description Filter by the products in the order. Comma-separated, one or more UUIDs. */
|
|
33333
33287
|
productRef?: string;
|
|
33334
|
-
/**
|
|
33335
|
-
* @description Filter by order status. Comma-separated values, e.g. `new,inProgress`. Defaults to `new`, `inProgress`, and `completed` when omitted.
|
|
33336
|
-
*
|
|
33337
|
-
* Supported values:
|
|
33338
|
-
* - **new** — placed, awaiting fulfillment
|
|
33339
|
-
* - **inProgress** — being fulfilled
|
|
33340
|
-
* - **completed** — fulfilled
|
|
33341
|
-
* - **canceled** — canceled
|
|
33342
|
-
*/
|
|
33288
|
+
/** @description Filter by order status: 'pending' placed, payment still processing; 'new' placed and paid, awaiting fulfillment; 'inProgress' being fulfilled; 'completed' fulfilled; 'canceled' canceled by the customer or an admin. Defaults to new, inProgress and completed. Comma-separated, one or more of: canceled, completed, inProgress, new, pending. */
|
|
33343
33289
|
status?: string;
|
|
33344
33290
|
/** @description UUID of the user whose orders to list. */
|
|
33345
33291
|
userRef?: string;
|
|
@@ -33419,13 +33365,13 @@ interface operations {
|
|
|
33419
33365
|
customerRef?: string;
|
|
33420
33366
|
/** @description Maximum number of subscriptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
33421
33367
|
limit?: number;
|
|
33422
|
-
/** @description UUID of the location whose subscriptions to list. */
|
|
33368
|
+
/** @description UUID of the location whose subscriptions to list. Omit locationRef and customerRef to list subscriptions across every location of the network, grouped by location. */
|
|
33423
33369
|
locationRef?: string;
|
|
33424
33370
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
33425
33371
|
nextPageToken?: string;
|
|
33426
|
-
/** @description Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions
|
|
33372
|
+
/** @description Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions and needs locationRef. Defaults to createDate:desc. */
|
|
33427
33373
|
order?: string;
|
|
33428
|
-
/** @description UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
|
|
33374
|
+
/** @description UUID of the plan to filter subscriptions by. Applies to a location's or the network's subscriptions. */
|
|
33429
33375
|
planRef?: string;
|
|
33430
33376
|
/** @description Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
|
|
33431
33377
|
status?: string;
|
|
@@ -35483,13 +35429,13 @@ interface GetSubscriptionsQuery {
|
|
|
35483
35429
|
customerRef?: string;
|
|
35484
35430
|
/** Maximum number of subscriptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35485
35431
|
limit?: number;
|
|
35486
|
-
/** UUID of the location whose subscriptions to list. */
|
|
35432
|
+
/** UUID of the location whose subscriptions to list. Omit locationRef and customerRef to list subscriptions across every location of the network, grouped by location. */
|
|
35487
35433
|
locationRef?: string;
|
|
35488
35434
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35489
35435
|
nextPageToken?: string;
|
|
35490
|
-
/** Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions
|
|
35436
|
+
/** Sort order as field:direction, where field is startDate, endDate, createDate or renewDate and direction is asc or desc, such as startDate:asc. Applies to a location's subscriptions and needs locationRef. Defaults to createDate:desc. */
|
|
35491
35437
|
order?: string;
|
|
35492
|
-
/** UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
|
|
35438
|
+
/** UUID of the plan to filter subscriptions by. Applies to a location's or the network's subscriptions. */
|
|
35493
35439
|
planRef?: string;
|
|
35494
35440
|
/** Filter by status: 'active' started and not ended or canceled, 'scheduled' starts in the future, 'incomplete' setup not finished (such as an unsigned contract or an unpaid purchase), 'incompleteExpired' setup was never finished (the contract was declined or the payment canceled), 'canceled' canceled or ended. Defaults to active, scheduled and incomplete. Comma-separated, one or more of: active, scheduled, incomplete, incompleteExpired, canceled. */
|
|
35495
35441
|
status?: string;
|
|
@@ -35513,7 +35459,7 @@ type ProductMedia = NonNullable<operations["createProductMedia"]["responses"][20
|
|
|
35513
35459
|
type ShopCategory = NonNullable<components["schemas"]["shopCategory"]>;
|
|
35514
35460
|
/** Query parameters for `sb.shop.orders.list()`. */
|
|
35515
35461
|
interface GetOrdersQuery {
|
|
35516
|
-
/**
|
|
35462
|
+
/** Filter by the shop categories of the products in the order. Comma-separated, one or more UUIDs. */
|
|
35517
35463
|
categoryRef?: string;
|
|
35518
35464
|
/** Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
|
|
35519
35465
|
"createDate[gte]"?: string;
|
|
@@ -35527,15 +35473,9 @@ interface GetOrdersQuery {
|
|
|
35527
35473
|
locationRef?: string;
|
|
35528
35474
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35529
35475
|
nextPageToken?: string;
|
|
35530
|
-
/**
|
|
35476
|
+
/** Filter by the products in the order. Comma-separated, one or more UUIDs. */
|
|
35531
35477
|
productRef?: string;
|
|
35532
|
-
/** Filter by order status
|
|
35533
|
-
|
|
35534
|
-
Supported values:
|
|
35535
|
-
- **new** — placed, awaiting fulfillment
|
|
35536
|
-
- **inProgress** — being fulfilled
|
|
35537
|
-
- **completed** — fulfilled
|
|
35538
|
-
- **canceled** — canceled */
|
|
35478
|
+
/** Filter by order status: 'pending' placed, payment still processing; 'new' placed and paid, awaiting fulfillment; 'inProgress' being fulfilled; 'completed' fulfilled; 'canceled' canceled by the customer or an admin. Defaults to new, inProgress and completed. Comma-separated, one or more of: canceled, completed, inProgress, new, pending. */
|
|
35539
35479
|
status?: string;
|
|
35540
35480
|
/** UUID of the user whose orders to list. */
|
|
35541
35481
|
userRef?: string;
|
|
@@ -35544,7 +35484,7 @@ interface GetOrdersQuery {
|
|
|
35544
35484
|
interface GetProductsQuery {
|
|
35545
35485
|
/** UUID of the shop category. */
|
|
35546
35486
|
categoryRef?: string;
|
|
35547
|
-
/**
|
|
35487
|
+
/** Product UUIDs to get, up to 25 per request. Comma-separated, one or more UUIDs. */
|
|
35548
35488
|
id?: string;
|
|
35549
35489
|
/** Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35550
35490
|
limit?: number;
|
|
@@ -35616,7 +35556,7 @@ interface GetBookingsQuery {
|
|
|
35616
35556
|
includeDeleted?: string;
|
|
35617
35557
|
/** Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35618
35558
|
limit?: number;
|
|
35619
|
-
/** UUID of the location whose bookings to list.
|
|
35559
|
+
/** UUID of the location whose bookings to list. Omit to list bookings across every location of the network. */
|
|
35620
35560
|
locationRef?: string;
|
|
35621
35561
|
/** @deprecated Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
35622
35562
|
membershipRefOwner?: string;
|
|
@@ -35624,19 +35564,19 @@ interface GetBookingsQuery {
|
|
|
35624
35564
|
nextPageToken?: string;
|
|
35625
35565
|
/** Sort order as `:`, where field is startDate, endDate, createDate or deleteDate and direction is asc or desc. deleteDate lists only cancelled bookings, by when they were cancelled, and cannot be combined with singleBookings. Defaults to startDate:asc when a startDate filter is given, endDate:asc when only an endDate filter is given, and createDate:desc otherwise. */
|
|
35626
35566
|
order?: string;
|
|
35627
|
-
/** UUID of the resource whose bookings to list.
|
|
35567
|
+
/** UUID of the resource whose bookings to list. */
|
|
35628
35568
|
resourceRef?: string;
|
|
35629
35569
|
/** Set to "true" to expand repeating bookings into single occurrences. */
|
|
35630
35570
|
singleBookings?: string;
|
|
35631
35571
|
/** @deprecated Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
35632
35572
|
startDate?: string;
|
|
35633
|
-
/**
|
|
35573
|
+
/** Booking statuses to filter by, e.g. `confirmed,canceled`. Defaults to tentative and confirmed, or to canceled when ordering by deleteDate. Comma-separated, one or more of: tentative, confirmed, canceled. */
|
|
35634
35574
|
status?: string;
|
|
35635
|
-
/**
|
|
35575
|
+
/** Resource types of the booked resources to filter by, e.g. `room,hotDesk`. Defaults to all bookable types. Comma-separated, one or more of: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. */
|
|
35636
35576
|
type?: string;
|
|
35637
|
-
/** UUID of the user whose bookings to list, both made and attended.
|
|
35577
|
+
/** UUID of the user whose bookings to list, both made and attended. Without locationRef or resourceRef, lists the user's bookings across every location of the network. Cannot be combined with customerRef, companyRefOwner, or userRefOwner. */
|
|
35638
35578
|
userRef?: string;
|
|
35639
|
-
/** UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Cannot be combined with customerRef, companyRefOwner, or userRef. */
|
|
35579
|
+
/** UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Without locationRef or resourceRef, lists the user's own bookings across every location of the network. Cannot be combined with customerRef, companyRefOwner, or userRef. */
|
|
35640
35580
|
userRefOwner?: string;
|
|
35641
35581
|
/** @deprecated Use type instead. */
|
|
35642
35582
|
types?: string;
|
|
@@ -35645,11 +35585,11 @@ interface GetBookingsQuery {
|
|
|
35645
35585
|
interface GetResourcesQuery {
|
|
35646
35586
|
/** Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35647
35587
|
limit?: number;
|
|
35648
|
-
/** UUID of the location whose resources to list. */
|
|
35649
|
-
locationRef
|
|
35588
|
+
/** UUID of the location whose resources to list. Omit to list resources across every location of the network. */
|
|
35589
|
+
locationRef?: string;
|
|
35650
35590
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35651
35591
|
nextPageToken?: string;
|
|
35652
|
-
/**
|
|
35592
|
+
/** Resource types to filter by, e.g. `room,hotDesk`. Defaults to all bookable types. Comma-separated, one or more of: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. */
|
|
35653
35593
|
type?: string;
|
|
35654
35594
|
/** @deprecated Use type instead. */
|
|
35655
35595
|
types?: string;
|
|
@@ -35689,7 +35629,7 @@ interface GetPlansQuery {
|
|
|
35689
35629
|
entire?: string;
|
|
35690
35630
|
/** Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35691
35631
|
limit?: number;
|
|
35692
|
-
/** UUID of the location whose plans to list. */
|
|
35632
|
+
/** UUID of the location whose plans to list. Omit to list plans across every location of the network. */
|
|
35693
35633
|
locationRef?: string;
|
|
35694
35634
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35695
35635
|
nextPageToken?: string;
|
|
@@ -35698,10 +35638,6 @@ interface GetPlansQuery {
|
|
|
35698
35638
|
}
|
|
35699
35639
|
/** Request body for `sb.plans.create()`. */
|
|
35700
35640
|
type CreatePlanBody = NonNullable<NonNullable<operations["createPlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
|
|
35701
|
-
/** Request body for `sb.plans.deletePlans()`. */
|
|
35702
|
-
type DeletePlansBody = NonNullable<NonNullable<operations["deletePlans"]["requestBody"]>["content"]["application/json"]["planIds"]>;
|
|
35703
|
-
/** Request body for `sb.plans.patchPlans()`. */
|
|
35704
|
-
type PatchPlansBody = NonNullable<NonNullable<operations["patchPlans"]["requestBody"]>["content"]["application/json"]["plans"]>;
|
|
35705
35641
|
/** Request body for `sb.plans.update()`. */
|
|
35706
35642
|
type UpdatePlanBody = NonNullable<NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
|
|
35707
35643
|
|
|
@@ -35711,8 +35647,8 @@ type Package = NonNullable<operations["getPackages"]["responses"][200]["content"
|
|
|
35711
35647
|
interface GetPackagesQuery {
|
|
35712
35648
|
/** Maximum number of packages per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35713
35649
|
limit?: number;
|
|
35714
|
-
/** UUID of the location. */
|
|
35715
|
-
locationRef
|
|
35650
|
+
/** UUID of the location whose packages to list. Omit to list packages across every location of the network. */
|
|
35651
|
+
locationRef?: string;
|
|
35716
35652
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35717
35653
|
nextPageToken?: string;
|
|
35718
35654
|
}
|
|
@@ -35737,8 +35673,8 @@ type GuideMedia = NonNullable<operations["createGuideMedia"]["responses"][201]["
|
|
|
35737
35673
|
interface GetGuidesQuery {
|
|
35738
35674
|
/** Maximum number of guides per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35739
35675
|
limit?: number;
|
|
35740
|
-
/** UUID of the location whose guides to list. */
|
|
35741
|
-
locationRef
|
|
35676
|
+
/** UUID of the location whose guides to list. Omit to list guides across every location of the network. */
|
|
35677
|
+
locationRef?: string;
|
|
35742
35678
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35743
35679
|
nextPageToken?: string;
|
|
35744
35680
|
}
|
|
@@ -35795,14 +35731,34 @@ type EventMedia = NonNullable<operations["createEventMedia"]["responses"][201]["
|
|
|
35795
35731
|
type EventTicket = NonNullable<components["schemas"]["eventTicket"]>;
|
|
35796
35732
|
/** Query parameters for `sb.events.list()`. */
|
|
35797
35733
|
interface GetEventsByOrganizationQuery {
|
|
35798
|
-
/**
|
|
35799
|
-
|
|
35800
|
-
/**
|
|
35734
|
+
/** Filter events whose create date is on or after this date (ISO 8601). */
|
|
35735
|
+
"createDate[gte]"?: string;
|
|
35736
|
+
/** Filter events whose create date is on or before this date (ISO 8601). */
|
|
35737
|
+
"createDate[lte]"?: string;
|
|
35738
|
+
/** Filter events whose end date is after this date (ISO 8601). */
|
|
35739
|
+
"endDate[gt]"?: string;
|
|
35740
|
+
/** Filter events whose end date is on or after this date (ISO 8601). */
|
|
35741
|
+
"endDate[gte]"?: string;
|
|
35742
|
+
/** Filter events whose end date is before this date (ISO 8601). */
|
|
35743
|
+
"endDate[lt]"?: string;
|
|
35744
|
+
/** Filter events whose end date is on or before this date (ISO 8601). */
|
|
35745
|
+
"endDate[lte]"?: string;
|
|
35746
|
+
/** Maximum number of events per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35801
35747
|
limit?: number;
|
|
35802
|
-
/**
|
|
35748
|
+
/** UUID of the location whose events to list. */
|
|
35749
|
+
locationRef: string;
|
|
35750
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35803
35751
|
nextPageToken?: string;
|
|
35804
|
-
/**
|
|
35752
|
+
/** Sort order of events. One of relevance, createDate:asc, createDate:desc, startDate:asc, startDate:desc, endDate:asc, endDate:desc. */
|
|
35805
35753
|
order?: string;
|
|
35754
|
+
/** Filter events whose start date is after this date (ISO 8601). */
|
|
35755
|
+
"startDate[gt]"?: string;
|
|
35756
|
+
/** Filter events whose start date is on or after this date (ISO 8601). */
|
|
35757
|
+
"startDate[gte]"?: string;
|
|
35758
|
+
/** Filter events whose start date is before this date (ISO 8601). */
|
|
35759
|
+
"startDate[lt]"?: string;
|
|
35760
|
+
/** Filter events whose start date is on or before this date (ISO 8601). */
|
|
35761
|
+
"startDate[lte]"?: string;
|
|
35806
35762
|
}
|
|
35807
35763
|
/** Query parameters for `sb.events.tickets.list()`. */
|
|
35808
35764
|
interface GetEventTicketsQuery {
|
|
@@ -35818,11 +35774,7 @@ interface GetEventTicketsQuery {
|
|
|
35818
35774
|
locationRef?: string;
|
|
35819
35775
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35820
35776
|
nextPageToken?: string;
|
|
35821
|
-
/** Filter by event ticket status
|
|
35822
|
-
|
|
35823
|
-
Supported values:
|
|
35824
|
-
- **active** — the ticket is valid
|
|
35825
|
-
- **canceled** — the ticket was deleted */
|
|
35777
|
+
/** Filter by event ticket status: 'active' the ticket is valid, 'canceled' the ticket was deleted. Defaults to active. Comma-separated, one or more of: active, canceled. */
|
|
35826
35778
|
status?: string;
|
|
35827
35779
|
/** UUID of the user whose event tickets to list. */
|
|
35828
35780
|
userRef?: string;
|
|
@@ -35846,32 +35798,32 @@ type Promocode = NonNullable<components["schemas"]["promocode"]>;
|
|
|
35846
35798
|
type Redemption = NonNullable<components["schemas"]["discountRedemption"]>;
|
|
35847
35799
|
/** Query parameters for `sb.discounts.coupons.list()`. */
|
|
35848
35800
|
interface GetCouponsQuery {
|
|
35849
|
-
/**
|
|
35850
|
-
locationRef: string;
|
|
35851
|
-
/** Comma-separated list of coupon types to filter by */
|
|
35852
|
-
type?: "creditPackages" | "desks" | "equipment" | "events" | "products" | "rooms" | "subscriptionItems";
|
|
35853
|
-
/** The number of coupons to retrieve. Default: 25 */
|
|
35801
|
+
/** Maximum number of coupons per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35854
35802
|
limit?: number;
|
|
35855
|
-
/**
|
|
35803
|
+
/** UUID of the location whose coupons to list. Omit to list coupons across every location of the network. */
|
|
35804
|
+
locationRef?: string;
|
|
35805
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35856
35806
|
nextPageToken?: string;
|
|
35807
|
+
/** Filter by the product types a coupon applies to; a coupon matches when it applies to any of them. Comma-separated, one or more of: roomBookings, eventSpaceBookings, conferenceRoomBookings, meetingRoomBookings, phoneBoothBookings, stationBookings, studioBookings, hotDeskBookings, dedicatedDeskBookings, officeBookings, parkingBookings, equipmentBookings, eventTickets, shopProducts, packages, subscriptionItems. */
|
|
35808
|
+
type?: string;
|
|
35857
35809
|
}
|
|
35858
35810
|
/** Query parameters for `sb.discounts.listRedemptions()`. */
|
|
35859
35811
|
interface GetDiscountRedemptionsQuery {
|
|
35860
|
-
/**
|
|
35812
|
+
/** UUID of the coupon whose redemptions to list. */
|
|
35861
35813
|
couponRef?: string;
|
|
35862
|
-
/**
|
|
35863
|
-
promocodeRef?: string;
|
|
35864
|
-
/** The number of items to return */
|
|
35814
|
+
/** Maximum number of discount redemptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35865
35815
|
limit?: number;
|
|
35866
|
-
/**
|
|
35816
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35867
35817
|
nextPageToken?: string;
|
|
35818
|
+
/** UUID of the promocode whose redemptions to list. */
|
|
35819
|
+
promocodeRef?: string;
|
|
35868
35820
|
}
|
|
35869
35821
|
/** Query parameters for `sb.discounts.promocodes.list()`. */
|
|
35870
35822
|
interface GetPromocodesQuery {
|
|
35871
|
-
/**
|
|
35872
|
-
locationRef?: string;
|
|
35873
|
-
/** The id of the coupon. At least one of locationRef or couponRef is required */
|
|
35823
|
+
/** UUID of the coupon whose promocodes to list. */
|
|
35874
35824
|
couponRef?: string;
|
|
35825
|
+
/** UUID of the location whose promocodes to list. Omit with couponRef to list promocodes across every location of the network. */
|
|
35826
|
+
locationRef?: string;
|
|
35875
35827
|
}
|
|
35876
35828
|
/** Request body for `sb.discounts.coupons.create()`. */
|
|
35877
35829
|
type CreateCouponBody = NonNullable<NonNullable<operations["createCoupon"]["requestBody"]>["content"]["application/json"]["coupon"]>;
|
|
@@ -35892,15 +35844,15 @@ interface GetContractsQuery {
|
|
|
35892
35844
|
"createDate[gte]"?: string;
|
|
35893
35845
|
/** Filter contracts created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
35894
35846
|
"createDate[lte]"?: string;
|
|
35895
|
-
/** UUID of the customer (membership or company).
|
|
35847
|
+
/** UUID of the customer (membership or company). When set, returns only that customer's contracts. */
|
|
35896
35848
|
customerRef?: string;
|
|
35897
35849
|
/** Maximum number of contracts per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35898
35850
|
limit?: number;
|
|
35899
|
-
/** UUID of the location.
|
|
35851
|
+
/** UUID of the location. When set, returns contracts in that location. Omit both locationRef and customerRef to list contracts across every location of the network. */
|
|
35900
35852
|
locationRef?: string;
|
|
35901
35853
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35902
35854
|
nextPageToken?: string;
|
|
35903
|
-
/** Case-insensitive search by contract title
|
|
35855
|
+
/** Case-insensitive search by contract title, within customerRef or locationRef when given and across the network otherwise. */
|
|
35904
35856
|
q?: string;
|
|
35905
35857
|
/** Filter by status: 'draft' created and not sent yet, 'issued' sent and waiting for signatures, 'signed' signed by everyone and active, 'declined' a signer declined it or it expired unsigned, 'terminated' ended by an admin after it was signed. Defaults to every status. Comma-separated, one or more of: draft, issued, signed, declined, terminated. */
|
|
35906
35858
|
status?: string;
|
|
@@ -35909,8 +35861,8 @@ interface GetContractsQuery {
|
|
|
35909
35861
|
interface GetTemplatesQuery {
|
|
35910
35862
|
/** Maximum number of templates per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35911
35863
|
limit?: number;
|
|
35912
|
-
/** UUID of the location. */
|
|
35913
|
-
locationRef
|
|
35864
|
+
/** UUID of the location whose templates to list. Omit to list templates across every location of the network. */
|
|
35865
|
+
locationRef?: string;
|
|
35914
35866
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35915
35867
|
nextPageToken?: string;
|
|
35916
35868
|
}
|
|
@@ -36039,11 +35991,7 @@ interface GetCreditNotesQuery {
|
|
|
36039
35991
|
locationRef?: string;
|
|
36040
35992
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36041
35993
|
nextPageToken?: string;
|
|
36042
|
-
/** Filter by credit note status. Comma-separated
|
|
36043
|
-
|
|
36044
|
-
Supported values:
|
|
36045
|
-
- **issued** — active credit note
|
|
36046
|
-
- **voided** — cancelled and no longer valid */
|
|
35994
|
+
/** Filter by credit note status: issued (in effect) or voided (cancelled and no longer valid). Comma-separated, one or more of: issued, voided. */
|
|
36047
35995
|
status?: string;
|
|
36048
35996
|
}
|
|
36049
35997
|
/** Query parameters for `sb.billing.invoices.list()`. */
|
|
@@ -36070,13 +36018,7 @@ interface GetInvoicesQuery {
|
|
|
36070
36018
|
nextPageToken?: string;
|
|
36071
36019
|
/** Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
|
|
36072
36020
|
q?: string;
|
|
36073
|
-
/** Filter by invoice status. Comma-separated
|
|
36074
|
-
|
|
36075
|
-
Supported values:
|
|
36076
|
-
- **draft** — created but not sent
|
|
36077
|
-
- **issued** — sent to the customer but unpaid
|
|
36078
|
-
- **paid** — fully paid
|
|
36079
|
-
- **voided** — cancelled and no longer valid */
|
|
36021
|
+
/** Filter by invoice status: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
36080
36022
|
status?: string;
|
|
36081
36023
|
}
|
|
36082
36024
|
/** Query parameters for `sb.billing.invoices.items.getUpcoming()`. */
|
|
@@ -36111,19 +36053,13 @@ interface ListInvoiceItemsQuery {
|
|
|
36111
36053
|
locationRef?: string;
|
|
36112
36054
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36113
36055
|
nextPageToken?: string;
|
|
36114
|
-
/** Filter by the status of the invoice the item is on. Items not on an invoice are excluded. Comma-separated
|
|
36115
|
-
|
|
36116
|
-
Supported values:
|
|
36117
|
-
- **draft** — created but not sent
|
|
36118
|
-
- **issued** — sent to the customer but unpaid
|
|
36119
|
-
- **paid** — fully paid
|
|
36120
|
-
- **voided** — cancelled and no longer valid */
|
|
36056
|
+
/** Filter by the status of the invoice the item is on: draft (created but not sent), issued (sent to the customer but unpaid), paid (fully paid) or voided (cancelled and no longer valid). Items not on an invoice are excluded. Comma-separated, one or more of: draft, issued, paid, voided. */
|
|
36121
36057
|
status?: string;
|
|
36122
36058
|
/** UUID of the invoice whose items to list, in place of customerRef or locationRef or with them. Pages and sorts like the rest of the list, and the other filters still apply. */
|
|
36123
36059
|
invoiceRef?: string;
|
|
36124
36060
|
/** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
36125
36061
|
pending?: "true" | "false";
|
|
36126
|
-
/** Filter by invoice item type. Comma-separated
|
|
36062
|
+
/** Filter by invoice item type. Comma-separated, one or more of: creditPackage, custom, booking, eventTicket, subscription, order. */
|
|
36127
36063
|
type?: string;
|
|
36128
36064
|
}
|
|
36129
36065
|
/** Request body for `sb.billing.creditNotes.create()`. */
|
|
@@ -36167,7 +36103,7 @@ interface GetBenefitApplicationsQuery {
|
|
|
36167
36103
|
customerRef?: string;
|
|
36168
36104
|
/** Maximum number of applications per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
36169
36105
|
limit?: number;
|
|
36170
|
-
/** UUID of the location. */
|
|
36106
|
+
/** UUID of the location. Omit locationRef, benefitRef, customerRef and userRef to list applications across every location of the network. */
|
|
36171
36107
|
locationRef?: string;
|
|
36172
36108
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36173
36109
|
nextPageToken?: string;
|
|
@@ -36176,8 +36112,8 @@ interface GetBenefitApplicationsQuery {
|
|
|
36176
36112
|
}
|
|
36177
36113
|
/** Query parameters for `sb.benefits.categories.list()`. */
|
|
36178
36114
|
interface GetBenefitCategoriesQuery {
|
|
36179
|
-
/** UUID of the location whose benefit categories to list. */
|
|
36180
|
-
locationRef
|
|
36115
|
+
/** UUID of the location whose benefit categories to list, in member-facing order. Omit to list the categories of every location of the network. */
|
|
36116
|
+
locationRef?: string;
|
|
36181
36117
|
}
|
|
36182
36118
|
/** Query parameters for `sb.benefits.list()`. */
|
|
36183
36119
|
interface GetBenefitsQuery {
|
|
@@ -36187,7 +36123,7 @@ interface GetBenefitsQuery {
|
|
|
36187
36123
|
featured?: boolean;
|
|
36188
36124
|
/** Maximum number of benefits per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
36189
36125
|
limit?: number;
|
|
36190
|
-
/** UUID of the location. */
|
|
36126
|
+
/** UUID of the location. Omit both locationRef and categoryRef to list benefits across every location of the network. */
|
|
36191
36127
|
locationRef?: string;
|
|
36192
36128
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36193
36129
|
nextPageToken?: string;
|
|
@@ -36229,6 +36165,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36229
36165
|
searchQueryNext?: string;
|
|
36230
36166
|
}>;
|
|
36231
36167
|
iterate(query: Omit<GetAltCurrenciesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<AltCurrency, void, undefined>;
|
|
36168
|
+
get(id: string, options?: SpacebringRequestOptions): Promise<AltCurrency>;
|
|
36232
36169
|
create(altCurrency: CreateAltCurrencyBody, options?: SpacebringRequestOptions): Promise<AltCurrency>;
|
|
36233
36170
|
update(id: string, altCurrency: UpdateAltCurrencyBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36234
36171
|
delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36256,7 +36193,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36256
36193
|
create(application: ApplyBenefitBody, options?: SpacebringRequestOptions): Promise<Application>;
|
|
36257
36194
|
};
|
|
36258
36195
|
categories: {
|
|
36259
|
-
list(query
|
|
36196
|
+
list(query?: GetBenefitCategoriesQuery, options?: SpacebringRequestOptions): Promise<BenefitCategory[]>;
|
|
36260
36197
|
get(categoryId: string, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
|
|
36261
36198
|
create(category: CreateBenefitCategoryBody, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
|
|
36262
36199
|
update(categoryId: string, category: UpdateBenefitCategoryBody, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
|
|
@@ -36377,12 +36314,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36377
36314
|
signContract(contractId: string, signerId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36378
36315
|
terminate(contractId: string, reason: TerminateContractBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36379
36316
|
templates: {
|
|
36380
|
-
list(query
|
|
36317
|
+
list(query?: GetTemplatesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36381
36318
|
nextPageToken?: string;
|
|
36382
36319
|
searchQueryNext?: string;
|
|
36383
36320
|
templates: Template[];
|
|
36384
36321
|
}>;
|
|
36385
|
-
iterate(query
|
|
36322
|
+
iterate(query?: Omit<GetTemplatesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Template, void, undefined>;
|
|
36386
36323
|
get(templateId: string, options?: SpacebringRequestOptions): Promise<Template>;
|
|
36387
36324
|
create(template: CreateTemplateBody, options?: SpacebringRequestOptions): Promise<Template>;
|
|
36388
36325
|
update(templateId: string, template: UpdateTemplateBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36399,12 +36336,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36399
36336
|
searchQueryNext?: string;
|
|
36400
36337
|
}>;
|
|
36401
36338
|
coupons: {
|
|
36402
|
-
list(query
|
|
36339
|
+
list(query?: GetCouponsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36403
36340
|
coupons?: Coupon[];
|
|
36404
36341
|
nextPageToken?: string;
|
|
36405
36342
|
searchQueryNext?: string;
|
|
36406
36343
|
}>;
|
|
36407
|
-
iterate(query
|
|
36344
|
+
iterate(query?: Omit<GetCouponsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Coupon, void, undefined>;
|
|
36408
36345
|
get(id: string, options?: SpacebringRequestOptions): Promise<Coupon>;
|
|
36409
36346
|
create(coupon: CreateCouponBody, options?: SpacebringRequestOptions): Promise<Coupon>;
|
|
36410
36347
|
update(id: string, coupon: UpdateCouponBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36470,12 +36407,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36470
36407
|
delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36471
36408
|
};
|
|
36472
36409
|
guides: {
|
|
36473
|
-
list(query
|
|
36410
|
+
list(query?: GetGuidesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36474
36411
|
guides: Guide[];
|
|
36475
36412
|
nextPageToken?: string;
|
|
36476
36413
|
searchQueryNext?: string;
|
|
36477
36414
|
}>;
|
|
36478
|
-
iterate(query
|
|
36415
|
+
iterate(query?: Omit<GetGuidesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Guide, void, undefined>;
|
|
36479
36416
|
get(guideId: string, options?: SpacebringRequestOptions): Promise<Guide>;
|
|
36480
36417
|
create(guide: CreateGuideBody, options?: SpacebringRequestOptions): Promise<Guide>;
|
|
36481
36418
|
update(guideId: string, guide: PatchGuideBody, options?: SpacebringRequestOptions): Promise<Guide>;
|
|
@@ -36491,12 +36428,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36491
36428
|
list(options?: SpacebringRequestOptions): Promise<Network[]>;
|
|
36492
36429
|
};
|
|
36493
36430
|
packages: {
|
|
36494
|
-
list(query
|
|
36431
|
+
list(query?: GetPackagesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36495
36432
|
nextPageToken?: string;
|
|
36496
36433
|
packages: Package[];
|
|
36497
36434
|
searchQueryNext?: string;
|
|
36498
36435
|
}>;
|
|
36499
|
-
iterate(query
|
|
36436
|
+
iterate(query?: Omit<GetPackagesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Package, void, undefined>;
|
|
36500
36437
|
create(packageBody: CreatePackageBody, options?: SpacebringRequestOptions): Promise<Package>;
|
|
36501
36438
|
update(packageId: string, packageBody: PatchPackageBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36502
36439
|
delete(packageId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36512,8 +36449,6 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36512
36449
|
create(plan: CreatePlanBody, options?: SpacebringRequestOptions): Promise<Plan>;
|
|
36513
36450
|
update(planId: string, plan: UpdatePlanBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36514
36451
|
delete(planId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36515
|
-
deletePlans(planIds: DeletePlansBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36516
|
-
patchPlans(plans: PatchPlansBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36517
36452
|
};
|
|
36518
36453
|
registrations: {
|
|
36519
36454
|
list(query?: GetRegistrationsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
@@ -36524,12 +36459,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36524
36459
|
iterate(query?: Omit<GetRegistrationsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Registration, void, undefined>;
|
|
36525
36460
|
};
|
|
36526
36461
|
resources: {
|
|
36527
|
-
list(query
|
|
36462
|
+
list(query?: GetResourcesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36528
36463
|
nextPageToken?: string;
|
|
36529
36464
|
resources: Resource[];
|
|
36530
36465
|
searchQueryNext?: string;
|
|
36531
36466
|
}>;
|
|
36532
|
-
iterate(query
|
|
36467
|
+
iterate(query?: Omit<GetResourcesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Resource, void, undefined>;
|
|
36533
36468
|
get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
36534
36469
|
create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
36535
36470
|
update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36789,4 +36724,4 @@ declare class SpacebringError extends Error {
|
|
|
36789
36724
|
});
|
|
36790
36725
|
}
|
|
36791
36726
|
|
|
36792
|
-
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Attachment, type Balance, type Benefit, type BenefitCategory, type BenefitMedia, type Booking, type CheckIn, type CheckInBody, type CheckInVisitBody, type CheckOutBody, type CheckOutVisitBody, type Comment, type Company, type CompanyMedia, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateAssignmentBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBenefitMediaBody, type CreateBookingBody, type CreateCompanyBody, type CreateCompanyMediaBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateEventMediaBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateFeedPostMediaBody, type CreateGuideAttachmentBody, type CreateGuideBody, type CreateGuideMediaBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreateMoneyTransactionBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreateProductMediaBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateResourceMediaBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateSupportTicketMediaBody, type CreateTemplateBody, type CreateTemplateMediaBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type
|
|
36727
|
+
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Attachment, type Balance, type Benefit, type BenefitCategory, type BenefitMedia, type Booking, type CheckIn, type CheckInBody, type CheckInVisitBody, type CheckOutBody, type CheckOutVisitBody, type Comment, type Company, type CompanyMedia, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateAssignmentBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBenefitMediaBody, type CreateBookingBody, type CreateCompanyBody, type CreateCompanyMediaBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateEventMediaBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateFeedPostMediaBody, type CreateGuideAttachmentBody, type CreateGuideBody, type CreateGuideMediaBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreateMoneyTransactionBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreateProductMediaBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateResourceMediaBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateSupportTicketMediaBody, type CreateTemplateBody, type CreateTemplateMediaBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventMedia, type EventTicket, type FeedMedia, type GetAltCurrenciesQuery, type GetAssignmentsQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCheckInsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourceAvailability, type GetResourceAvailabilityBody, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type GuideMedia, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchAssignmentBody, type PatchBookingBody, type PatchGuideBody, type PatchMoneyTransactionBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type ProductMedia, type Promocode, type Redemption, type Refund, type RefundMoneyTransactionBody, type Registration, type Request$1 as Request, type Resource, type ResourceMedia, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TemplateMedia, type TerminateContractBody, type TicketMedia, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketCommentBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };
|