@izak0s/spacebring-api 12.0.0 → 14.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/dist/index.cjs +20 -18
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +376 -405
- package/dist/index.d.ts +376 -405
- package/dist/index.js +20 -18
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
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;
|
|
@@ -2048,7 +2052,11 @@ interface paths {
|
|
|
2048
2052
|
path?: never;
|
|
2049
2053
|
cookie?: never;
|
|
2050
2054
|
};
|
|
2051
|
-
|
|
2055
|
+
/**
|
|
2056
|
+
* Retrieve a package
|
|
2057
|
+
* @description Retrieve a package. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
2058
|
+
*/
|
|
2059
|
+
get: operations["getPackage"];
|
|
2052
2060
|
put?: never;
|
|
2053
2061
|
post?: never;
|
|
2054
2062
|
/**
|
|
@@ -2083,18 +2091,10 @@ interface paths {
|
|
|
2083
2091
|
* @description Create a plan. <h3>OAuth</h3>Required scopes: <code>plans</code>
|
|
2084
2092
|
*/
|
|
2085
2093
|
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"];
|
|
2094
|
+
delete?: never;
|
|
2091
2095
|
options?: never;
|
|
2092
2096
|
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"];
|
|
2097
|
+
patch?: never;
|
|
2098
2098
|
trace?: never;
|
|
2099
2099
|
};
|
|
2100
2100
|
"/plans/v1/{planId}": {
|
|
@@ -3250,6 +3250,35 @@ interface components {
|
|
|
3250
3250
|
message?: string;
|
|
3251
3251
|
type?: string;
|
|
3252
3252
|
};
|
|
3253
|
+
getAltCurrency: {
|
|
3254
|
+
/** @description The alt currency. */
|
|
3255
|
+
altCurrency: {
|
|
3256
|
+
/**
|
|
3257
|
+
* Format: date-time
|
|
3258
|
+
* @description ISO timestamp of when the alt currency was created.
|
|
3259
|
+
*/
|
|
3260
|
+
createDate: string;
|
|
3261
|
+
/** @description ISO 4217 currency code. */
|
|
3262
|
+
currencyCode: string;
|
|
3263
|
+
/** @description Exchange rate relative to the location main currency. */
|
|
3264
|
+
exchangeRate: number;
|
|
3265
|
+
/**
|
|
3266
|
+
* Format: uuid
|
|
3267
|
+
* @description Unique identifier of the alt currency.
|
|
3268
|
+
*/
|
|
3269
|
+
id: string;
|
|
3270
|
+
/**
|
|
3271
|
+
* Format: uuid
|
|
3272
|
+
* @description ID of the location this alt currency belongs to.
|
|
3273
|
+
*/
|
|
3274
|
+
locationRef: string;
|
|
3275
|
+
/**
|
|
3276
|
+
* @description Exchange rate provider when auto-update is enabled.
|
|
3277
|
+
* @enum {string}
|
|
3278
|
+
*/
|
|
3279
|
+
provider?: "nbu" | "bcra" | "nbg" | "bcch" | "ecb";
|
|
3280
|
+
};
|
|
3281
|
+
};
|
|
3253
3282
|
getBenefitCategories: {
|
|
3254
3283
|
/** @description List of benefit categories. */
|
|
3255
3284
|
categories: {
|
|
@@ -5235,11 +5264,16 @@ interface components {
|
|
|
5235
5264
|
promocode?: {
|
|
5236
5265
|
/** @description Promocode string. */
|
|
5237
5266
|
code: string;
|
|
5238
|
-
/**
|
|
5239
|
-
|
|
5240
|
-
|
|
5241
|
-
|
|
5242
|
-
|
|
5267
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
5268
|
+
expiration?: {
|
|
5269
|
+
/**
|
|
5270
|
+
* Format: date-time
|
|
5271
|
+
* @description ISO timestamp when the promocode expires.
|
|
5272
|
+
*/
|
|
5273
|
+
date?: string;
|
|
5274
|
+
/** @description Whether the promocode has an expiration date. */
|
|
5275
|
+
enabled: boolean;
|
|
5276
|
+
};
|
|
5243
5277
|
/**
|
|
5244
5278
|
* Format: uuid
|
|
5245
5279
|
* @description Promocode ID.
|
|
@@ -5636,11 +5670,16 @@ interface components {
|
|
|
5636
5670
|
promocode?: {
|
|
5637
5671
|
/** @description Promocode string. */
|
|
5638
5672
|
code: string;
|
|
5639
|
-
/**
|
|
5640
|
-
|
|
5641
|
-
|
|
5642
|
-
|
|
5643
|
-
|
|
5673
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
5674
|
+
expiration?: {
|
|
5675
|
+
/**
|
|
5676
|
+
* Format: date-time
|
|
5677
|
+
* @description ISO timestamp when the promocode expires.
|
|
5678
|
+
*/
|
|
5679
|
+
date?: string;
|
|
5680
|
+
/** @description Whether the promocode has an expiration date. */
|
|
5681
|
+
enabled: boolean;
|
|
5682
|
+
};
|
|
5644
5683
|
/**
|
|
5645
5684
|
* Format: uuid
|
|
5646
5685
|
* @description Promocode ID.
|
|
@@ -5976,8 +6015,16 @@ interface components {
|
|
|
5976
6015
|
/** @description Promocode applied. */
|
|
5977
6016
|
promocode?: {
|
|
5978
6017
|
code: string;
|
|
5979
|
-
/**
|
|
5980
|
-
expiration?:
|
|
6018
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
6019
|
+
expiration?: {
|
|
6020
|
+
/**
|
|
6021
|
+
* Format: date-time
|
|
6022
|
+
* @description ISO timestamp when the promocode expires.
|
|
6023
|
+
*/
|
|
6024
|
+
date?: string;
|
|
6025
|
+
/** @description Whether the promocode has an expiration date. */
|
|
6026
|
+
enabled: boolean;
|
|
6027
|
+
};
|
|
5981
6028
|
/** Format: uuid */
|
|
5982
6029
|
id: string;
|
|
5983
6030
|
limitByFirstPurchase?: boolean;
|
|
@@ -6303,8 +6350,16 @@ interface components {
|
|
|
6303
6350
|
/** @description Promocode applied. */
|
|
6304
6351
|
promocode?: {
|
|
6305
6352
|
code: string;
|
|
6306
|
-
/**
|
|
6307
|
-
expiration?:
|
|
6353
|
+
/** @description Promocode expiration settings, as the promocode had them when it was applied. */
|
|
6354
|
+
expiration?: {
|
|
6355
|
+
/**
|
|
6356
|
+
* Format: date-time
|
|
6357
|
+
* @description ISO timestamp when the promocode expires.
|
|
6358
|
+
*/
|
|
6359
|
+
date?: string;
|
|
6360
|
+
/** @description Whether the promocode has an expiration date. */
|
|
6361
|
+
enabled: boolean;
|
|
6362
|
+
};
|
|
6308
6363
|
/** Format: uuid */
|
|
6309
6364
|
id: string;
|
|
6310
6365
|
limitByFirstPurchase?: boolean;
|
|
@@ -7614,11 +7669,11 @@ interface components {
|
|
|
7614
7669
|
*/
|
|
7615
7670
|
id: string;
|
|
7616
7671
|
/** @description First name of the user. */
|
|
7617
|
-
name
|
|
7672
|
+
name?: string;
|
|
7618
7673
|
/** @description Profile photo URL. */
|
|
7619
7674
|
photoUrl: string | null;
|
|
7620
7675
|
/** @description Surname of the user. */
|
|
7621
|
-
surname
|
|
7676
|
+
surname?: string;
|
|
7622
7677
|
};
|
|
7623
7678
|
};
|
|
7624
7679
|
/**
|
|
@@ -7841,6 +7896,8 @@ interface components {
|
|
|
7841
7896
|
* @enum {string}
|
|
7842
7897
|
*/
|
|
7843
7898
|
ticketAvailability: "soldOut" | "limited" | "available";
|
|
7899
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omitted when unlimited. */
|
|
7900
|
+
ticketsPerAttendee?: number;
|
|
7844
7901
|
/** @description Display name of the event. */
|
|
7845
7902
|
title: string;
|
|
7846
7903
|
/** @description Venue name or address within the location. */
|
|
@@ -8065,15 +8122,6 @@ interface components {
|
|
|
8065
8122
|
*/
|
|
8066
8123
|
type?: "company" | "user";
|
|
8067
8124
|
};
|
|
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
8125
|
};
|
|
8078
8126
|
/** @description Invoice method details. */
|
|
8079
8127
|
invoice?: {
|
|
@@ -8138,15 +8186,6 @@ interface components {
|
|
|
8138
8186
|
};
|
|
8139
8187
|
/** @description Human-readable label of the payment method (e.g. 'Visa 4242'). */
|
|
8140
8188
|
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
8189
|
/** @description Masked payment method identifier. */
|
|
8151
8190
|
mask?: string;
|
|
8152
8191
|
/** @description Payment gateway title. */
|
|
@@ -8256,7 +8295,7 @@ interface components {
|
|
|
8256
8295
|
* @description Payment type.
|
|
8257
8296
|
* @enum {string}
|
|
8258
8297
|
*/
|
|
8259
|
-
type: "authorizenet" | "credits" | "external" | "flow" | "fondy" | "freedompay" | "hyperpay" | "invoice" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
8298
|
+
type: "authorizenet" | "credits" | "external" | "flow" | "fondy" | "freedompay" | "hyperpay" | "invoice" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
8260
8299
|
};
|
|
8261
8300
|
/** @description Number of tickets included in this purchase. */
|
|
8262
8301
|
quantity: number;
|
|
@@ -9677,8 +9716,6 @@ interface components {
|
|
|
9677
9716
|
lastSeenDate?: string;
|
|
9678
9717
|
/** @description Location-scoped admin permissions. Included only for owners and super admins or when viewing the current user's registration. */
|
|
9679
9718
|
locationPermissions?: {
|
|
9680
|
-
/** @description Whether the admin can manage other admins. */
|
|
9681
|
-
admins: boolean;
|
|
9682
9719
|
/** @description Whether permissions apply to all locations. */
|
|
9683
9720
|
allLocations: boolean;
|
|
9684
9721
|
/** @description Whether the admin can access analytics. */
|
|
@@ -9687,8 +9724,11 @@ interface components {
|
|
|
9687
9724
|
benefits: boolean;
|
|
9688
9725
|
/** @description Whether the admin can manage billing. */
|
|
9689
9726
|
billing: boolean;
|
|
9690
|
-
/**
|
|
9691
|
-
|
|
9727
|
+
/**
|
|
9728
|
+
* @deprecated
|
|
9729
|
+
* @description Deprecated. Use resources instead.
|
|
9730
|
+
*/
|
|
9731
|
+
bookings?: boolean;
|
|
9692
9732
|
/** @description Whether the admin can manage customers. */
|
|
9693
9733
|
customers: boolean;
|
|
9694
9734
|
/** @description Whether the admin can manage events. */
|
|
@@ -9902,14 +9942,14 @@ interface components {
|
|
|
9902
9942
|
* @enum {string}
|
|
9903
9943
|
*/
|
|
9904
9944
|
bookingUnit: "hour" | "day";
|
|
9905
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
9945
|
+
/** @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
9946
|
bookingWindow: {
|
|
9907
9947
|
/**
|
|
9908
9948
|
* @description How far ahead users can book the resource.
|
|
9909
9949
|
* @enum {string}
|
|
9910
9950
|
*/
|
|
9911
9951
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
9912
|
-
/** @description Whether the resource
|
|
9952
|
+
/** @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
9953
|
enabled: boolean;
|
|
9914
9954
|
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
9915
9955
|
minNotice?: number;
|
|
@@ -10606,14 +10646,14 @@ interface components {
|
|
|
10606
10646
|
* @enum {string}
|
|
10607
10647
|
*/
|
|
10608
10648
|
bookingUnit: "hour" | "day";
|
|
10609
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
10649
|
+
/** @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
10650
|
bookingWindow: {
|
|
10611
10651
|
/**
|
|
10612
10652
|
* @description How far ahead users can book the resource.
|
|
10613
10653
|
* @enum {string}
|
|
10614
10654
|
*/
|
|
10615
10655
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
10616
|
-
/** @description Whether the resource
|
|
10656
|
+
/** @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
10657
|
enabled: boolean;
|
|
10618
10658
|
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
10619
10659
|
minNotice?: number;
|
|
@@ -11817,7 +11857,7 @@ interface components {
|
|
|
11817
11857
|
* @description Payment gateway that processed the charge.
|
|
11818
11858
|
* @enum {string}
|
|
11819
11859
|
*/
|
|
11820
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
11860
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
11821
11861
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
11822
11862
|
label?: string;
|
|
11823
11863
|
/** @description Masked payment method identifier. */
|
|
@@ -12252,7 +12292,7 @@ interface components {
|
|
|
12252
12292
|
* @description Payment gateway that processed the charge.
|
|
12253
12293
|
* @enum {string}
|
|
12254
12294
|
*/
|
|
12255
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12295
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12256
12296
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
12257
12297
|
label?: string;
|
|
12258
12298
|
/** @description Masked payment method identifier. */
|
|
@@ -12899,7 +12939,7 @@ interface components {
|
|
|
12899
12939
|
* @description Payment gateway that processed the charge.
|
|
12900
12940
|
* @enum {string}
|
|
12901
12941
|
*/
|
|
12902
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12942
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
12903
12943
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
12904
12944
|
label?: string;
|
|
12905
12945
|
/** @description Masked payment method identifier. */
|
|
@@ -13334,7 +13374,7 @@ interface components {
|
|
|
13334
13374
|
* @description Payment gateway that processed the charge.
|
|
13335
13375
|
* @enum {string}
|
|
13336
13376
|
*/
|
|
13337
|
-
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
13377
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
13338
13378
|
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
13339
13379
|
label?: string;
|
|
13340
13380
|
/** @description Masked payment method identifier. */
|
|
@@ -14508,7 +14548,7 @@ interface components {
|
|
|
14508
14548
|
* @description Payment gateway type.
|
|
14509
14549
|
* @enum {string}
|
|
14510
14550
|
*/
|
|
14511
|
-
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
14551
|
+
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
14512
14552
|
};
|
|
14513
14553
|
/**
|
|
14514
14554
|
* @description Payment method type.
|
|
@@ -15057,7 +15097,7 @@ interface components {
|
|
|
15057
15097
|
* @description Payment gateway type.
|
|
15058
15098
|
* @enum {string}
|
|
15059
15099
|
*/
|
|
15060
|
-
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
15100
|
+
type?: "authorizenet" | "flow" | "fondy" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "mollie" | "xendit";
|
|
15061
15101
|
};
|
|
15062
15102
|
/**
|
|
15063
15103
|
* @description Payment method type.
|
|
@@ -17321,7 +17361,7 @@ interface components {
|
|
|
17321
17361
|
/** @description Profile image URL of the Lem AI assistant. */
|
|
17322
17362
|
photoUrl: string;
|
|
17323
17363
|
};
|
|
17324
|
-
/** @description Membership of the user who performed the action. */
|
|
17364
|
+
/** @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
17365
|
membership?: {
|
|
17326
17366
|
/**
|
|
17327
17367
|
* Format: uuid
|
|
@@ -17352,6 +17392,9 @@ interface components {
|
|
|
17352
17392
|
/** @description Surname of the user. */
|
|
17353
17393
|
surname?: string | null;
|
|
17354
17394
|
};
|
|
17395
|
+
} | {
|
|
17396
|
+
/** @description Empty user. */
|
|
17397
|
+
user: Record<string, never>;
|
|
17355
17398
|
};
|
|
17356
17399
|
/**
|
|
17357
17400
|
* Format: uuid
|
|
@@ -22309,7 +22352,7 @@ interface components {
|
|
|
22309
22352
|
/** @description Location where the visit takes place. */
|
|
22310
22353
|
location: {
|
|
22311
22354
|
/** @description Street address of the location. */
|
|
22312
|
-
address?: string;
|
|
22355
|
+
address?: string | null;
|
|
22313
22356
|
/**
|
|
22314
22357
|
* Format: uuid
|
|
22315
22358
|
* @description Unique identifier of the location.
|
|
@@ -22814,7 +22857,7 @@ interface components {
|
|
|
22814
22857
|
* @description Payment gateway provider.
|
|
22815
22858
|
* @enum {string}
|
|
22816
22859
|
*/
|
|
22817
|
-
gateway: "authorizenet" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22860
|
+
gateway: "authorizenet" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22818
22861
|
/**
|
|
22819
22862
|
* Format: uuid
|
|
22820
22863
|
* @description ID of the saved payment method.
|
|
@@ -22842,7 +22885,7 @@ interface components {
|
|
|
22842
22885
|
* @description Payment gateway type.
|
|
22843
22886
|
* @enum {string}
|
|
22844
22887
|
*/
|
|
22845
|
-
type: "authorizenet" | "external" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22888
|
+
type: "authorizenet" | "external" | "freedompay" | "hyperpay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "paytabs" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
22846
22889
|
};
|
|
22847
22890
|
/** @description Whether the user has accepted the payment terms. */
|
|
22848
22891
|
termsConsent?: boolean;
|
|
@@ -23675,6 +23718,8 @@ interface components {
|
|
|
23675
23718
|
* @description ISO timestamp of when the event starts.
|
|
23676
23719
|
*/
|
|
23677
23720
|
startDate: string;
|
|
23721
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omit it for unlimited. */
|
|
23722
|
+
ticketsPerAttendee?: number;
|
|
23678
23723
|
/** @description Display name of the event. */
|
|
23679
23724
|
title: string;
|
|
23680
23725
|
/** @description Venue name or address within the location. */
|
|
@@ -23767,6 +23812,8 @@ interface components {
|
|
|
23767
23812
|
* @description ISO timestamp of when the event starts.
|
|
23768
23813
|
*/
|
|
23769
23814
|
startDate: string;
|
|
23815
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omit it for unlimited. */
|
|
23816
|
+
ticketsPerAttendee?: number;
|
|
23770
23817
|
/** @description Display name of the event. */
|
|
23771
23818
|
title: string;
|
|
23772
23819
|
/** @description Venue name or address within the location. */
|
|
@@ -24249,48 +24296,10 @@ interface components {
|
|
|
24249
24296
|
};
|
|
24250
24297
|
};
|
|
24251
24298
|
};
|
|
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
24299
|
updatePlan: {
|
|
24291
24300
|
content: {
|
|
24292
24301
|
"application/json": {
|
|
24293
|
-
/** @description Plan fields to
|
|
24302
|
+
/** @description Plan fields to change. Omitted fields keep their current values. */
|
|
24294
24303
|
plan: {
|
|
24295
24304
|
/** @description Third-party access integrations. */
|
|
24296
24305
|
access?: {
|
|
@@ -24318,15 +24327,9 @@ interface components {
|
|
|
24318
24327
|
/** Format: uuid */
|
|
24319
24328
|
id: string;
|
|
24320
24329
|
}[];
|
|
24321
|
-
/**
|
|
24322
|
-
* @description Number of billing cycles the member is committed to.
|
|
24323
|
-
* @default 0
|
|
24324
|
-
*/
|
|
24330
|
+
/** @description Number of billing cycles the member is committed to. */
|
|
24325
24331
|
commitmentCycles?: number;
|
|
24326
|
-
/**
|
|
24327
|
-
* @description Credits included in the plan.
|
|
24328
|
-
* @default 0
|
|
24329
|
-
*/
|
|
24332
|
+
/** @description Credits included in the plan. */
|
|
24330
24333
|
credits?: number;
|
|
24331
24334
|
/** @description Custom tax settings. */
|
|
24332
24335
|
customTax?: {
|
|
@@ -24335,15 +24338,9 @@ interface components {
|
|
|
24335
24338
|
/** @description Custom tax rate percentage. */
|
|
24336
24339
|
rate: number;
|
|
24337
24340
|
};
|
|
24338
|
-
/**
|
|
24339
|
-
* @description Number of day passes included in the plan.
|
|
24340
|
-
* @default 0
|
|
24341
|
-
*/
|
|
24341
|
+
/** @description Number of day passes included in the plan. */
|
|
24342
24342
|
dayPasses?: number;
|
|
24343
|
-
/**
|
|
24344
|
-
* @description Description of the plan.
|
|
24345
|
-
* @default
|
|
24346
|
-
*/
|
|
24343
|
+
/** @description Description of the plan. */
|
|
24347
24344
|
description?: string;
|
|
24348
24345
|
/**
|
|
24349
24346
|
* @deprecated
|
|
@@ -24363,12 +24360,7 @@ interface components {
|
|
|
24363
24360
|
/** @description Discount percentage for shop products. */
|
|
24364
24361
|
shop: number;
|
|
24365
24362
|
};
|
|
24366
|
-
/**
|
|
24367
|
-
* @description Resources and benefits exclusively available to members on this plan.
|
|
24368
|
-
* @default {
|
|
24369
|
-
* "resourceRefs": []
|
|
24370
|
-
* }
|
|
24371
|
-
*/
|
|
24363
|
+
/** @description Resources and benefits exclusively available to members on this plan. */
|
|
24372
24364
|
exclusiveAccess?: {
|
|
24373
24365
|
/** @description Benefit IDs with exclusive access for this plan. */
|
|
24374
24366
|
benefitRefs?: string[];
|
|
@@ -24414,10 +24406,7 @@ interface components {
|
|
|
24414
24406
|
*/
|
|
24415
24407
|
type: "immediate" | "request";
|
|
24416
24408
|
};
|
|
24417
|
-
/**
|
|
24418
|
-
* @description One-time setup fee.
|
|
24419
|
-
* @default 0
|
|
24420
|
-
*/
|
|
24409
|
+
/** @description One-time setup fee. */
|
|
24421
24410
|
setupFee?: number;
|
|
24422
24411
|
/** @description Display name of the plan. */
|
|
24423
24412
|
title?: string;
|
|
@@ -24454,14 +24443,14 @@ interface components {
|
|
|
24454
24443
|
* @enum {string}
|
|
24455
24444
|
*/
|
|
24456
24445
|
bookingUnit?: "hour" | "day";
|
|
24457
|
-
/** @description How soon and how far ahead users can book this resource. While enabled is false,
|
|
24446
|
+
/** @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
24447
|
bookingWindow?: {
|
|
24459
24448
|
/**
|
|
24460
|
-
* @description How far ahead users can book the resource
|
|
24449
|
+
* @description How far ahead users can book the resource. Required while enabled is true.
|
|
24461
24450
|
* @enum {string}
|
|
24462
24451
|
*/
|
|
24463
24452
|
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24464
|
-
/** @description Whether the resource
|
|
24453
|
+
/** @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
24454
|
enabled: boolean;
|
|
24466
24455
|
/** @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
24456
|
minNotice?: number;
|
|
@@ -24548,11 +24537,6 @@ interface components {
|
|
|
24548
24537
|
/** @description Whether two-way sync is enabled. */
|
|
24549
24538
|
twoWaySyncEnabled: boolean;
|
|
24550
24539
|
} | null;
|
|
24551
|
-
/**
|
|
24552
|
-
* Format: uuid
|
|
24553
|
-
* @description Optional client-provided resource id.
|
|
24554
|
-
*/
|
|
24555
|
-
id?: string;
|
|
24556
24540
|
/** @description Kisi access group reference. */
|
|
24557
24541
|
kisiGroupRef?: number | null;
|
|
24558
24542
|
/**
|
|
@@ -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
|
};
|
|
@@ -31948,6 +31962,41 @@ interface operations {
|
|
|
31948
31962
|
};
|
|
31949
31963
|
};
|
|
31950
31964
|
};
|
|
31965
|
+
getPackage: {
|
|
31966
|
+
parameters: {
|
|
31967
|
+
query?: never;
|
|
31968
|
+
header?: {
|
|
31969
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31970
|
+
"spacebring-network-id"?: string;
|
|
31971
|
+
};
|
|
31972
|
+
path: {
|
|
31973
|
+
/** @description The id of the package. */
|
|
31974
|
+
packageId: string;
|
|
31975
|
+
};
|
|
31976
|
+
cookie?: never;
|
|
31977
|
+
};
|
|
31978
|
+
requestBody?: never;
|
|
31979
|
+
responses: {
|
|
31980
|
+
/** @description OK */
|
|
31981
|
+
200: {
|
|
31982
|
+
headers: {
|
|
31983
|
+
[name: string]: unknown;
|
|
31984
|
+
};
|
|
31985
|
+
content: {
|
|
31986
|
+
"application/json": components["schemas"]["getPackage"];
|
|
31987
|
+
};
|
|
31988
|
+
};
|
|
31989
|
+
/** @description Bad Request */
|
|
31990
|
+
400: {
|
|
31991
|
+
headers: {
|
|
31992
|
+
[name: string]: unknown;
|
|
31993
|
+
};
|
|
31994
|
+
content: {
|
|
31995
|
+
"application/json": components["schemas"]["responseError"];
|
|
31996
|
+
};
|
|
31997
|
+
};
|
|
31998
|
+
};
|
|
31999
|
+
};
|
|
31951
32000
|
deletePackage: {
|
|
31952
32001
|
parameters: {
|
|
31953
32002
|
query?: never;
|
|
@@ -32021,7 +32070,7 @@ interface operations {
|
|
|
32021
32070
|
entire?: string;
|
|
32022
32071
|
/** @description Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
32023
32072
|
limit?: number;
|
|
32024
|
-
/** @description UUID of the location whose plans to list. */
|
|
32073
|
+
/** @description UUID of the location whose plans to list. Omit to list plans across every location of the network. */
|
|
32025
32074
|
locationRef?: string;
|
|
32026
32075
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
32027
32076
|
nextPageToken?: string;
|
|
@@ -32088,66 +32137,6 @@ interface operations {
|
|
|
32088
32137
|
};
|
|
32089
32138
|
};
|
|
32090
32139
|
};
|
|
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
32140
|
getPlan: {
|
|
32152
32141
|
parameters: {
|
|
32153
32142
|
query?: never;
|
|
@@ -32292,14 +32281,14 @@ interface operations {
|
|
|
32292
32281
|
};
|
|
32293
32282
|
getResources: {
|
|
32294
32283
|
parameters: {
|
|
32295
|
-
query
|
|
32284
|
+
query?: {
|
|
32296
32285
|
/** @description Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
32297
32286
|
limit?: number;
|
|
32298
|
-
/** @description UUID of the location whose resources to list. */
|
|
32299
|
-
locationRef
|
|
32287
|
+
/** @description UUID of the location whose resources to list. Omit to list resources across every location of the network. */
|
|
32288
|
+
locationRef?: string;
|
|
32300
32289
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
32301
32290
|
nextPageToken?: string;
|
|
32302
|
-
/** @description
|
|
32291
|
+
/** @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
32292
|
type?: string;
|
|
32304
32293
|
/** @description Deprecated. Use type instead. */
|
|
32305
32294
|
types?: string;
|
|
@@ -32723,7 +32712,7 @@ interface operations {
|
|
|
32723
32712
|
includeDeleted?: string;
|
|
32724
32713
|
/** @description Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
32725
32714
|
limit?: number;
|
|
32726
|
-
/** @description UUID of the location whose bookings to list.
|
|
32715
|
+
/** @description UUID of the location whose bookings to list. Omit to list bookings across every location of the network. */
|
|
32727
32716
|
locationRef?: string;
|
|
32728
32717
|
/** @description Deprecated. Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
32729
32718
|
membershipRefOwner?: string;
|
|
@@ -32731,19 +32720,19 @@ interface operations {
|
|
|
32731
32720
|
nextPageToken?: string;
|
|
32732
32721
|
/** @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
32722
|
order?: string;
|
|
32734
|
-
/** @description UUID of the resource whose bookings to list.
|
|
32723
|
+
/** @description UUID of the resource whose bookings to list. */
|
|
32735
32724
|
resourceRef?: string;
|
|
32736
32725
|
/** @description Set to "true" to expand repeating bookings into single occurrences. */
|
|
32737
32726
|
singleBookings?: string;
|
|
32738
32727
|
/** @description Deprecated. Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
32739
32728
|
startDate?: string;
|
|
32740
|
-
/** @description
|
|
32729
|
+
/** @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
32730
|
status?: string;
|
|
32742
|
-
/** @description
|
|
32731
|
+
/** @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
32732
|
type?: string;
|
|
32744
|
-
/** @description UUID of the user whose bookings to list, both made and attended.
|
|
32733
|
+
/** @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
32734
|
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. */
|
|
32735
|
+
/** @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
32736
|
userRefOwner?: string;
|
|
32748
32737
|
/** @description Deprecated. Use type instead. */
|
|
32749
32738
|
types?: string;
|
|
@@ -33091,7 +33080,7 @@ interface operations {
|
|
|
33091
33080
|
query?: {
|
|
33092
33081
|
/** @description UUID of the shop category. */
|
|
33093
33082
|
categoryRef?: string;
|
|
33094
|
-
/** @description
|
|
33083
|
+
/** @description Product UUIDs to get, up to 25 per request. Comma-separated, one or more UUIDs. */
|
|
33095
33084
|
id?: string;
|
|
33096
33085
|
/** @description Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
33097
33086
|
limit?: number;
|
|
@@ -33315,7 +33304,7 @@ interface operations {
|
|
|
33315
33304
|
getOrders: {
|
|
33316
33305
|
parameters: {
|
|
33317
33306
|
query?: {
|
|
33318
|
-
/** @description
|
|
33307
|
+
/** @description Filter by the shop categories of the products in the order. Comma-separated, one or more UUIDs. */
|
|
33319
33308
|
categoryRef?: string;
|
|
33320
33309
|
/** @description Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
|
|
33321
33310
|
"createDate[gte]"?: string;
|
|
@@ -33329,17 +33318,9 @@ interface operations {
|
|
|
33329
33318
|
locationRef?: string;
|
|
33330
33319
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
33331
33320
|
nextPageToken?: string;
|
|
33332
|
-
/** @description
|
|
33321
|
+
/** @description Filter by the products in the order. Comma-separated, one or more UUIDs. */
|
|
33333
33322
|
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
|
-
*/
|
|
33323
|
+
/** @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
33324
|
status?: string;
|
|
33344
33325
|
/** @description UUID of the user whose orders to list. */
|
|
33345
33326
|
userRef?: string;
|
|
@@ -33419,13 +33400,13 @@ interface operations {
|
|
|
33419
33400
|
customerRef?: string;
|
|
33420
33401
|
/** @description Maximum number of subscriptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
33421
33402
|
limit?: number;
|
|
33422
|
-
/** @description UUID of the location whose subscriptions to list. */
|
|
33403
|
+
/** @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
33404
|
locationRef?: string;
|
|
33424
33405
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
33425
33406
|
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
|
|
33407
|
+
/** @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
33408
|
order?: string;
|
|
33428
|
-
/** @description UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
|
|
33409
|
+
/** @description UUID of the plan to filter subscriptions by. Applies to a location's or the network's subscriptions. */
|
|
33429
33410
|
planRef?: string;
|
|
33430
33411
|
/** @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
33412
|
status?: string;
|
|
@@ -35483,13 +35464,13 @@ interface GetSubscriptionsQuery {
|
|
|
35483
35464
|
customerRef?: string;
|
|
35484
35465
|
/** Maximum number of subscriptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35485
35466
|
limit?: number;
|
|
35486
|
-
/** UUID of the location whose subscriptions to list. */
|
|
35467
|
+
/** 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
35468
|
locationRef?: string;
|
|
35488
35469
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35489
35470
|
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
|
|
35471
|
+
/** 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
35472
|
order?: string;
|
|
35492
|
-
/** UUID of the plan to filter subscriptions by. Applies to a location's subscriptions. */
|
|
35473
|
+
/** UUID of the plan to filter subscriptions by. Applies to a location's or the network's subscriptions. */
|
|
35493
35474
|
planRef?: string;
|
|
35494
35475
|
/** 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
35476
|
status?: string;
|
|
@@ -35513,7 +35494,7 @@ type ProductMedia = NonNullable<operations["createProductMedia"]["responses"][20
|
|
|
35513
35494
|
type ShopCategory = NonNullable<components["schemas"]["shopCategory"]>;
|
|
35514
35495
|
/** Query parameters for `sb.shop.orders.list()`. */
|
|
35515
35496
|
interface GetOrdersQuery {
|
|
35516
|
-
/**
|
|
35497
|
+
/** Filter by the shop categories of the products in the order. Comma-separated, one or more UUIDs. */
|
|
35517
35498
|
categoryRef?: string;
|
|
35518
35499
|
/** Filter orders created on or after this date (ISO 8601). Use with createDate[lte] for a range. */
|
|
35519
35500
|
"createDate[gte]"?: string;
|
|
@@ -35527,15 +35508,9 @@ interface GetOrdersQuery {
|
|
|
35527
35508
|
locationRef?: string;
|
|
35528
35509
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35529
35510
|
nextPageToken?: string;
|
|
35530
|
-
/**
|
|
35511
|
+
/** Filter by the products in the order. Comma-separated, one or more UUIDs. */
|
|
35531
35512
|
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 */
|
|
35513
|
+
/** 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
35514
|
status?: string;
|
|
35540
35515
|
/** UUID of the user whose orders to list. */
|
|
35541
35516
|
userRef?: string;
|
|
@@ -35544,7 +35519,7 @@ interface GetOrdersQuery {
|
|
|
35544
35519
|
interface GetProductsQuery {
|
|
35545
35520
|
/** UUID of the shop category. */
|
|
35546
35521
|
categoryRef?: string;
|
|
35547
|
-
/**
|
|
35522
|
+
/** Product UUIDs to get, up to 25 per request. Comma-separated, one or more UUIDs. */
|
|
35548
35523
|
id?: string;
|
|
35549
35524
|
/** Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35550
35525
|
limit?: number;
|
|
@@ -35616,7 +35591,7 @@ interface GetBookingsQuery {
|
|
|
35616
35591
|
includeDeleted?: string;
|
|
35617
35592
|
/** Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35618
35593
|
limit?: number;
|
|
35619
|
-
/** UUID of the location whose bookings to list.
|
|
35594
|
+
/** UUID of the location whose bookings to list. Omit to list bookings across every location of the network. */
|
|
35620
35595
|
locationRef?: string;
|
|
35621
35596
|
/** @deprecated Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
35622
35597
|
membershipRefOwner?: string;
|
|
@@ -35624,19 +35599,19 @@ interface GetBookingsQuery {
|
|
|
35624
35599
|
nextPageToken?: string;
|
|
35625
35600
|
/** 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
35601
|
order?: string;
|
|
35627
|
-
/** UUID of the resource whose bookings to list.
|
|
35602
|
+
/** UUID of the resource whose bookings to list. */
|
|
35628
35603
|
resourceRef?: string;
|
|
35629
35604
|
/** Set to "true" to expand repeating bookings into single occurrences. */
|
|
35630
35605
|
singleBookings?: string;
|
|
35631
35606
|
/** @deprecated Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
35632
35607
|
startDate?: string;
|
|
35633
|
-
/**
|
|
35608
|
+
/** 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
35609
|
status?: string;
|
|
35635
|
-
/**
|
|
35610
|
+
/** 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
35611
|
type?: string;
|
|
35637
|
-
/** UUID of the user whose bookings to list, both made and attended.
|
|
35612
|
+
/** 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
35613
|
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. */
|
|
35614
|
+
/** 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
35615
|
userRefOwner?: string;
|
|
35641
35616
|
/** @deprecated Use type instead. */
|
|
35642
35617
|
types?: string;
|
|
@@ -35645,11 +35620,11 @@ interface GetBookingsQuery {
|
|
|
35645
35620
|
interface GetResourcesQuery {
|
|
35646
35621
|
/** Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35647
35622
|
limit?: number;
|
|
35648
|
-
/** UUID of the location whose resources to list. */
|
|
35649
|
-
locationRef
|
|
35623
|
+
/** UUID of the location whose resources to list. Omit to list resources across every location of the network. */
|
|
35624
|
+
locationRef?: string;
|
|
35650
35625
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35651
35626
|
nextPageToken?: string;
|
|
35652
|
-
/**
|
|
35627
|
+
/** 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
35628
|
type?: string;
|
|
35654
35629
|
/** @deprecated Use type instead. */
|
|
35655
35630
|
types?: string;
|
|
@@ -35689,7 +35664,7 @@ interface GetPlansQuery {
|
|
|
35689
35664
|
entire?: string;
|
|
35690
35665
|
/** Maximum number of plans per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35691
35666
|
limit?: number;
|
|
35692
|
-
/** UUID of the location whose plans to list. */
|
|
35667
|
+
/** UUID of the location whose plans to list. Omit to list plans across every location of the network. */
|
|
35693
35668
|
locationRef?: string;
|
|
35694
35669
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35695
35670
|
nextPageToken?: string;
|
|
@@ -35698,21 +35673,17 @@ interface GetPlansQuery {
|
|
|
35698
35673
|
}
|
|
35699
35674
|
/** Request body for `sb.plans.create()`. */
|
|
35700
35675
|
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
35676
|
/** Request body for `sb.plans.update()`. */
|
|
35706
35677
|
type UpdatePlanBody = NonNullable<NonNullable<operations["updatePlan"]["requestBody"]>["content"]["application/json"]["plan"]>;
|
|
35707
35678
|
|
|
35708
35679
|
/** A Package entity as returned by the Spacebring API. */
|
|
35709
|
-
type Package = NonNullable<operations["
|
|
35680
|
+
type Package = NonNullable<operations["getPackage"]["responses"][200]["content"]["application/json"]["package"]>;
|
|
35710
35681
|
/** Query parameters for `sb.packages.list()`. */
|
|
35711
35682
|
interface GetPackagesQuery {
|
|
35712
35683
|
/** Maximum number of packages per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35713
35684
|
limit?: number;
|
|
35714
|
-
/** UUID of the location. */
|
|
35715
|
-
locationRef
|
|
35685
|
+
/** UUID of the location whose packages to list. Omit to list packages across every location of the network. */
|
|
35686
|
+
locationRef?: string;
|
|
35716
35687
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35717
35688
|
nextPageToken?: string;
|
|
35718
35689
|
}
|
|
@@ -35737,8 +35708,8 @@ type GuideMedia = NonNullable<operations["createGuideMedia"]["responses"][201]["
|
|
|
35737
35708
|
interface GetGuidesQuery {
|
|
35738
35709
|
/** Maximum number of guides per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35739
35710
|
limit?: number;
|
|
35740
|
-
/** UUID of the location whose guides to list. */
|
|
35741
|
-
locationRef
|
|
35711
|
+
/** UUID of the location whose guides to list. Omit to list guides across every location of the network. */
|
|
35712
|
+
locationRef?: string;
|
|
35742
35713
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35743
35714
|
nextPageToken?: string;
|
|
35744
35715
|
}
|
|
@@ -35795,14 +35766,34 @@ type EventMedia = NonNullable<operations["createEventMedia"]["responses"][201]["
|
|
|
35795
35766
|
type EventTicket = NonNullable<components["schemas"]["eventTicket"]>;
|
|
35796
35767
|
/** Query parameters for `sb.events.list()`. */
|
|
35797
35768
|
interface GetEventsByOrganizationQuery {
|
|
35798
|
-
/**
|
|
35799
|
-
|
|
35800
|
-
/**
|
|
35769
|
+
/** Filter events whose create date is on or after this date (ISO 8601). */
|
|
35770
|
+
"createDate[gte]"?: string;
|
|
35771
|
+
/** Filter events whose create date is on or before this date (ISO 8601). */
|
|
35772
|
+
"createDate[lte]"?: string;
|
|
35773
|
+
/** Filter events whose end date is after this date (ISO 8601). */
|
|
35774
|
+
"endDate[gt]"?: string;
|
|
35775
|
+
/** Filter events whose end date is on or after this date (ISO 8601). */
|
|
35776
|
+
"endDate[gte]"?: string;
|
|
35777
|
+
/** Filter events whose end date is before this date (ISO 8601). */
|
|
35778
|
+
"endDate[lt]"?: string;
|
|
35779
|
+
/** Filter events whose end date is on or before this date (ISO 8601). */
|
|
35780
|
+
"endDate[lte]"?: string;
|
|
35781
|
+
/** Maximum number of events per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35801
35782
|
limit?: number;
|
|
35802
|
-
/**
|
|
35783
|
+
/** UUID of the location whose events to list. */
|
|
35784
|
+
locationRef: string;
|
|
35785
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35803
35786
|
nextPageToken?: string;
|
|
35804
|
-
/**
|
|
35787
|
+
/** Sort order of events. One of relevance, createDate:asc, createDate:desc, startDate:asc, startDate:desc, endDate:asc, endDate:desc. */
|
|
35805
35788
|
order?: string;
|
|
35789
|
+
/** Filter events whose start date is after this date (ISO 8601). */
|
|
35790
|
+
"startDate[gt]"?: string;
|
|
35791
|
+
/** Filter events whose start date is on or after this date (ISO 8601). */
|
|
35792
|
+
"startDate[gte]"?: string;
|
|
35793
|
+
/** Filter events whose start date is before this date (ISO 8601). */
|
|
35794
|
+
"startDate[lt]"?: string;
|
|
35795
|
+
/** Filter events whose start date is on or before this date (ISO 8601). */
|
|
35796
|
+
"startDate[lte]"?: string;
|
|
35806
35797
|
}
|
|
35807
35798
|
/** Query parameters for `sb.events.tickets.list()`. */
|
|
35808
35799
|
interface GetEventTicketsQuery {
|
|
@@ -35818,11 +35809,7 @@ interface GetEventTicketsQuery {
|
|
|
35818
35809
|
locationRef?: string;
|
|
35819
35810
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35820
35811
|
nextPageToken?: string;
|
|
35821
|
-
/** Filter by event ticket status
|
|
35822
|
-
|
|
35823
|
-
Supported values:
|
|
35824
|
-
- **active** — the ticket is valid
|
|
35825
|
-
- **canceled** — the ticket was deleted */
|
|
35812
|
+
/** 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
35813
|
status?: string;
|
|
35827
35814
|
/** UUID of the user whose event tickets to list. */
|
|
35828
35815
|
userRef?: string;
|
|
@@ -35846,32 +35833,32 @@ type Promocode = NonNullable<components["schemas"]["promocode"]>;
|
|
|
35846
35833
|
type Redemption = NonNullable<components["schemas"]["discountRedemption"]>;
|
|
35847
35834
|
/** Query parameters for `sb.discounts.coupons.list()`. */
|
|
35848
35835
|
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 */
|
|
35836
|
+
/** Maximum number of coupons per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35854
35837
|
limit?: number;
|
|
35855
|
-
/**
|
|
35838
|
+
/** UUID of the location whose coupons to list. Omit to list coupons across every location of the network. */
|
|
35839
|
+
locationRef?: string;
|
|
35840
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35856
35841
|
nextPageToken?: string;
|
|
35842
|
+
/** 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. */
|
|
35843
|
+
type?: string;
|
|
35857
35844
|
}
|
|
35858
35845
|
/** Query parameters for `sb.discounts.listRedemptions()`. */
|
|
35859
35846
|
interface GetDiscountRedemptionsQuery {
|
|
35860
|
-
/**
|
|
35847
|
+
/** UUID of the coupon whose redemptions to list. */
|
|
35861
35848
|
couponRef?: string;
|
|
35862
|
-
/**
|
|
35863
|
-
promocodeRef?: string;
|
|
35864
|
-
/** The number of items to return */
|
|
35849
|
+
/** Maximum number of discount redemptions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35865
35850
|
limit?: number;
|
|
35866
|
-
/**
|
|
35851
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35867
35852
|
nextPageToken?: string;
|
|
35853
|
+
/** UUID of the promocode whose redemptions to list. */
|
|
35854
|
+
promocodeRef?: string;
|
|
35868
35855
|
}
|
|
35869
35856
|
/** Query parameters for `sb.discounts.promocodes.list()`. */
|
|
35870
35857
|
interface GetPromocodesQuery {
|
|
35871
|
-
/**
|
|
35872
|
-
locationRef?: string;
|
|
35873
|
-
/** The id of the coupon. At least one of locationRef or couponRef is required */
|
|
35858
|
+
/** UUID of the coupon whose promocodes to list. */
|
|
35874
35859
|
couponRef?: string;
|
|
35860
|
+
/** UUID of the location whose promocodes to list. Omit with couponRef to list promocodes across every location of the network. */
|
|
35861
|
+
locationRef?: string;
|
|
35875
35862
|
}
|
|
35876
35863
|
/** Request body for `sb.discounts.coupons.create()`. */
|
|
35877
35864
|
type CreateCouponBody = NonNullable<NonNullable<operations["createCoupon"]["requestBody"]>["content"]["application/json"]["coupon"]>;
|
|
@@ -35892,15 +35879,15 @@ interface GetContractsQuery {
|
|
|
35892
35879
|
"createDate[gte]"?: string;
|
|
35893
35880
|
/** Filter contracts created on or before this date (ISO 8601). Use with createDate[gte] for a range. */
|
|
35894
35881
|
"createDate[lte]"?: string;
|
|
35895
|
-
/** UUID of the customer (membership or company).
|
|
35882
|
+
/** UUID of the customer (membership or company). When set, returns only that customer's contracts. */
|
|
35896
35883
|
customerRef?: string;
|
|
35897
35884
|
/** Maximum number of contracts per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35898
35885
|
limit?: number;
|
|
35899
|
-
/** UUID of the location.
|
|
35886
|
+
/** 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
35887
|
locationRef?: string;
|
|
35901
35888
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35902
35889
|
nextPageToken?: string;
|
|
35903
|
-
/** Case-insensitive search by contract title
|
|
35890
|
+
/** Case-insensitive search by contract title, within customerRef or locationRef when given and across the network otherwise. */
|
|
35904
35891
|
q?: string;
|
|
35905
35892
|
/** 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
35893
|
status?: string;
|
|
@@ -35909,8 +35896,8 @@ interface GetContractsQuery {
|
|
|
35909
35896
|
interface GetTemplatesQuery {
|
|
35910
35897
|
/** Maximum number of templates per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35911
35898
|
limit?: number;
|
|
35912
|
-
/** UUID of the location. */
|
|
35913
|
-
locationRef
|
|
35899
|
+
/** UUID of the location whose templates to list. Omit to list templates across every location of the network. */
|
|
35900
|
+
locationRef?: string;
|
|
35914
35901
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35915
35902
|
nextPageToken?: string;
|
|
35916
35903
|
}
|
|
@@ -36039,11 +36026,7 @@ interface GetCreditNotesQuery {
|
|
|
36039
36026
|
locationRef?: string;
|
|
36040
36027
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36041
36028
|
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 */
|
|
36029
|
+
/** Filter by credit note status: issued (in effect) or voided (cancelled and no longer valid). Comma-separated, one or more of: issued, voided. */
|
|
36047
36030
|
status?: string;
|
|
36048
36031
|
}
|
|
36049
36032
|
/** Query parameters for `sb.billing.invoices.list()`. */
|
|
@@ -36070,13 +36053,7 @@ interface GetInvoicesQuery {
|
|
|
36070
36053
|
nextPageToken?: string;
|
|
36071
36054
|
/** Case-insensitive search by invoice code or number. Requires customerRef or locationRef. */
|
|
36072
36055
|
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 */
|
|
36056
|
+
/** 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
36057
|
status?: string;
|
|
36081
36058
|
}
|
|
36082
36059
|
/** Query parameters for `sb.billing.invoices.items.getUpcoming()`. */
|
|
@@ -36111,19 +36088,13 @@ interface ListInvoiceItemsQuery {
|
|
|
36111
36088
|
locationRef?: string;
|
|
36112
36089
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36113
36090
|
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 */
|
|
36091
|
+
/** 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
36092
|
status?: string;
|
|
36122
36093
|
/** 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
36094
|
invoiceRef?: string;
|
|
36124
36095
|
/** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
36125
36096
|
pending?: "true" | "false";
|
|
36126
|
-
/** Filter by invoice item type. Comma-separated
|
|
36097
|
+
/** Filter by invoice item type. Comma-separated, one or more of: creditPackage, custom, booking, eventTicket, subscription, order. */
|
|
36127
36098
|
type?: string;
|
|
36128
36099
|
}
|
|
36129
36100
|
/** Request body for `sb.billing.creditNotes.create()`. */
|
|
@@ -36167,7 +36138,7 @@ interface GetBenefitApplicationsQuery {
|
|
|
36167
36138
|
customerRef?: string;
|
|
36168
36139
|
/** Maximum number of applications per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
36169
36140
|
limit?: number;
|
|
36170
|
-
/** UUID of the location. */
|
|
36141
|
+
/** UUID of the location. Omit locationRef, benefitRef, customerRef and userRef to list applications across every location of the network. */
|
|
36171
36142
|
locationRef?: string;
|
|
36172
36143
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36173
36144
|
nextPageToken?: string;
|
|
@@ -36176,8 +36147,8 @@ interface GetBenefitApplicationsQuery {
|
|
|
36176
36147
|
}
|
|
36177
36148
|
/** Query parameters for `sb.benefits.categories.list()`. */
|
|
36178
36149
|
interface GetBenefitCategoriesQuery {
|
|
36179
|
-
/** UUID of the location whose benefit categories to list. */
|
|
36180
|
-
locationRef
|
|
36150
|
+
/** UUID of the location whose benefit categories to list, in member-facing order. Omit to list the categories of every location of the network. */
|
|
36151
|
+
locationRef?: string;
|
|
36181
36152
|
}
|
|
36182
36153
|
/** Query parameters for `sb.benefits.list()`. */
|
|
36183
36154
|
interface GetBenefitsQuery {
|
|
@@ -36187,7 +36158,7 @@ interface GetBenefitsQuery {
|
|
|
36187
36158
|
featured?: boolean;
|
|
36188
36159
|
/** Maximum number of benefits per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
36189
36160
|
limit?: number;
|
|
36190
|
-
/** UUID of the location. */
|
|
36161
|
+
/** UUID of the location. Omit both locationRef and categoryRef to list benefits across every location of the network. */
|
|
36191
36162
|
locationRef?: string;
|
|
36192
36163
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
36193
36164
|
nextPageToken?: string;
|
|
@@ -36229,6 +36200,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36229
36200
|
searchQueryNext?: string;
|
|
36230
36201
|
}>;
|
|
36231
36202
|
iterate(query: Omit<GetAltCurrenciesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<AltCurrency, void, undefined>;
|
|
36203
|
+
get(id: string, options?: SpacebringRequestOptions): Promise<AltCurrency>;
|
|
36232
36204
|
create(altCurrency: CreateAltCurrencyBody, options?: SpacebringRequestOptions): Promise<AltCurrency>;
|
|
36233
36205
|
update(id: string, altCurrency: UpdateAltCurrencyBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36234
36206
|
delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36256,7 +36228,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36256
36228
|
create(application: ApplyBenefitBody, options?: SpacebringRequestOptions): Promise<Application>;
|
|
36257
36229
|
};
|
|
36258
36230
|
categories: {
|
|
36259
|
-
list(query
|
|
36231
|
+
list(query?: GetBenefitCategoriesQuery, options?: SpacebringRequestOptions): Promise<BenefitCategory[]>;
|
|
36260
36232
|
get(categoryId: string, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
|
|
36261
36233
|
create(category: CreateBenefitCategoryBody, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
|
|
36262
36234
|
update(categoryId: string, category: UpdateBenefitCategoryBody, options?: SpacebringRequestOptions): Promise<BenefitCategory>;
|
|
@@ -36377,12 +36349,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36377
36349
|
signContract(contractId: string, signerId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36378
36350
|
terminate(contractId: string, reason: TerminateContractBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36379
36351
|
templates: {
|
|
36380
|
-
list(query
|
|
36352
|
+
list(query?: GetTemplatesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36381
36353
|
nextPageToken?: string;
|
|
36382
36354
|
searchQueryNext?: string;
|
|
36383
36355
|
templates: Template[];
|
|
36384
36356
|
}>;
|
|
36385
|
-
iterate(query
|
|
36357
|
+
iterate(query?: Omit<GetTemplatesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Template, void, undefined>;
|
|
36386
36358
|
get(templateId: string, options?: SpacebringRequestOptions): Promise<Template>;
|
|
36387
36359
|
create(template: CreateTemplateBody, options?: SpacebringRequestOptions): Promise<Template>;
|
|
36388
36360
|
update(templateId: string, template: UpdateTemplateBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36399,12 +36371,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36399
36371
|
searchQueryNext?: string;
|
|
36400
36372
|
}>;
|
|
36401
36373
|
coupons: {
|
|
36402
|
-
list(query
|
|
36374
|
+
list(query?: GetCouponsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36403
36375
|
coupons?: Coupon[];
|
|
36404
36376
|
nextPageToken?: string;
|
|
36405
36377
|
searchQueryNext?: string;
|
|
36406
36378
|
}>;
|
|
36407
|
-
iterate(query
|
|
36379
|
+
iterate(query?: Omit<GetCouponsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Coupon, void, undefined>;
|
|
36408
36380
|
get(id: string, options?: SpacebringRequestOptions): Promise<Coupon>;
|
|
36409
36381
|
create(coupon: CreateCouponBody, options?: SpacebringRequestOptions): Promise<Coupon>;
|
|
36410
36382
|
update(id: string, coupon: UpdateCouponBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36470,12 +36442,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36470
36442
|
delete(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36471
36443
|
};
|
|
36472
36444
|
guides: {
|
|
36473
|
-
list(query
|
|
36445
|
+
list(query?: GetGuidesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36474
36446
|
guides: Guide[];
|
|
36475
36447
|
nextPageToken?: string;
|
|
36476
36448
|
searchQueryNext?: string;
|
|
36477
36449
|
}>;
|
|
36478
|
-
iterate(query
|
|
36450
|
+
iterate(query?: Omit<GetGuidesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Guide, void, undefined>;
|
|
36479
36451
|
get(guideId: string, options?: SpacebringRequestOptions): Promise<Guide>;
|
|
36480
36452
|
create(guide: CreateGuideBody, options?: SpacebringRequestOptions): Promise<Guide>;
|
|
36481
36453
|
update(guideId: string, guide: PatchGuideBody, options?: SpacebringRequestOptions): Promise<Guide>;
|
|
@@ -36491,12 +36463,13 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36491
36463
|
list(options?: SpacebringRequestOptions): Promise<Network[]>;
|
|
36492
36464
|
};
|
|
36493
36465
|
packages: {
|
|
36494
|
-
list(query
|
|
36466
|
+
list(query?: GetPackagesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36495
36467
|
nextPageToken?: string;
|
|
36496
36468
|
packages: Package[];
|
|
36497
36469
|
searchQueryNext?: string;
|
|
36498
36470
|
}>;
|
|
36499
|
-
iterate(query
|
|
36471
|
+
iterate(query?: Omit<GetPackagesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Package, void, undefined>;
|
|
36472
|
+
get(packageId: string, options?: SpacebringRequestOptions): Promise<Package>;
|
|
36500
36473
|
create(packageBody: CreatePackageBody, options?: SpacebringRequestOptions): Promise<Package>;
|
|
36501
36474
|
update(packageId: string, packageBody: PatchPackageBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36502
36475
|
delete(packageId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36512,8 +36485,6 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36512
36485
|
create(plan: CreatePlanBody, options?: SpacebringRequestOptions): Promise<Plan>;
|
|
36513
36486
|
update(planId: string, plan: UpdatePlanBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36514
36487
|
delete(planId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36515
|
-
deletePlans(planIds: DeletePlansBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36516
|
-
patchPlans(plans: PatchPlansBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36517
36488
|
};
|
|
36518
36489
|
registrations: {
|
|
36519
36490
|
list(query?: GetRegistrationsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
@@ -36524,12 +36495,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36524
36495
|
iterate(query?: Omit<GetRegistrationsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Registration, void, undefined>;
|
|
36525
36496
|
};
|
|
36526
36497
|
resources: {
|
|
36527
|
-
list(query
|
|
36498
|
+
list(query?: GetResourcesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36528
36499
|
nextPageToken?: string;
|
|
36529
36500
|
resources: Resource[];
|
|
36530
36501
|
searchQueryNext?: string;
|
|
36531
36502
|
}>;
|
|
36532
|
-
iterate(query
|
|
36503
|
+
iterate(query?: Omit<GetResourcesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Resource, void, undefined>;
|
|
36533
36504
|
get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
36534
36505
|
create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
36535
36506
|
update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
@@ -36789,4 +36760,4 @@ declare class SpacebringError extends Error {
|
|
|
36789
36760
|
});
|
|
36790
36761
|
}
|
|
36791
36762
|
|
|
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
|
|
36763
|
+
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 };
|