@izak0s/spacebring-api 14.0.0 → 15.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +89 -1
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1003 -65
- package/dist/index.d.ts +1003 -65
- package/dist/index.js +89 -1
- package/dist/index.js.map +1 -1
- package/package.json +6 -6
package/dist/index.d.ts
CHANGED
|
@@ -444,7 +444,11 @@ interface paths {
|
|
|
444
444
|
delete: operations["deleteBenefit"];
|
|
445
445
|
options?: never;
|
|
446
446
|
head?: never;
|
|
447
|
-
|
|
447
|
+
/**
|
|
448
|
+
* Partially update a benefit
|
|
449
|
+
* @description Update the fields of a benefit that the request sets; omitted fields keep their current values. <h3>OAuth</h3>Required scopes: <code>benefits</code>
|
|
450
|
+
*/
|
|
451
|
+
patch: operations["patchBenefit"];
|
|
448
452
|
trace?: never;
|
|
449
453
|
};
|
|
450
454
|
"/benefits/v1/media": {
|
|
@@ -824,6 +828,26 @@ interface paths {
|
|
|
824
828
|
patch: operations["updateCreditNote"];
|
|
825
829
|
trace?: never;
|
|
826
830
|
};
|
|
831
|
+
"/billing/credit_notes/v1/{id}/void": {
|
|
832
|
+
parameters: {
|
|
833
|
+
query?: never;
|
|
834
|
+
header?: never;
|
|
835
|
+
path?: never;
|
|
836
|
+
cookie?: never;
|
|
837
|
+
};
|
|
838
|
+
get?: never;
|
|
839
|
+
/**
|
|
840
|
+
* Void a credit note
|
|
841
|
+
* @description Void a credit note permanently: the amount it took off the invoice is owed again. Only an issued credit note of type <code>prePayment</code> can be voided, while its invoice is still issued, unpaid and has no payment in progress. <h3>OAuth</h3>Required scopes: <code>invoices</code>
|
|
842
|
+
*/
|
|
843
|
+
put: operations["voidCreditNote"];
|
|
844
|
+
post?: never;
|
|
845
|
+
delete?: never;
|
|
846
|
+
options?: never;
|
|
847
|
+
head?: never;
|
|
848
|
+
patch?: never;
|
|
849
|
+
trace?: never;
|
|
850
|
+
};
|
|
827
851
|
"/billing/credit_notes/v1/preview": {
|
|
828
852
|
parameters: {
|
|
829
853
|
query?: never;
|
|
@@ -1493,7 +1517,11 @@ interface paths {
|
|
|
1493
1517
|
delete: operations["deleteEvent"];
|
|
1494
1518
|
options?: never;
|
|
1495
1519
|
head?: never;
|
|
1496
|
-
|
|
1520
|
+
/**
|
|
1521
|
+
* Partially update an event
|
|
1522
|
+
* @description Update the fields of an event that the request sets; omitted fields keep their current values. <h3>OAuth</h3>Required scopes: <code>events</code>
|
|
1523
|
+
*/
|
|
1524
|
+
patch: operations["patchEvent"];
|
|
1497
1525
|
trace?: never;
|
|
1498
1526
|
};
|
|
1499
1527
|
"/events/v1/{id}/cancel": {
|
|
@@ -1694,7 +1722,11 @@ interface paths {
|
|
|
1694
1722
|
delete: operations["deleteFeedPost"];
|
|
1695
1723
|
options?: never;
|
|
1696
1724
|
head?: never;
|
|
1697
|
-
|
|
1725
|
+
/**
|
|
1726
|
+
* Partially update a post
|
|
1727
|
+
* @description Update the fields of a feed post that the request sets; omitted fields keep their current values. <h3>OAuth</h3>Required scopes: <code>feed</code>
|
|
1728
|
+
*/
|
|
1729
|
+
patch: operations["patchFeedPost"];
|
|
1698
1730
|
trace?: never;
|
|
1699
1731
|
};
|
|
1700
1732
|
"/feed/posts/v1/{id}/comments": {
|
|
@@ -2200,10 +2232,18 @@ interface paths {
|
|
|
2200
2232
|
path?: never;
|
|
2201
2233
|
cookie?: never;
|
|
2202
2234
|
};
|
|
2203
|
-
|
|
2235
|
+
/**
|
|
2236
|
+
* Get a resource assignment
|
|
2237
|
+
* @description Get a resource assignment. <h3>OAuth</h3>Required scopes: <code>resources.readonly</code> or <code>resources</code>
|
|
2238
|
+
*/
|
|
2239
|
+
get: operations["getAssignment"];
|
|
2204
2240
|
put?: never;
|
|
2205
2241
|
post?: never;
|
|
2206
|
-
|
|
2242
|
+
/**
|
|
2243
|
+
* Delete a resource assignment
|
|
2244
|
+
* @description Delete a resource assignment. An assignment created by a subscription is removed with its subscription instead. <h3>OAuth</h3>Required scopes: <code>resources</code>
|
|
2245
|
+
*/
|
|
2246
|
+
delete: operations["deleteAssignment"];
|
|
2207
2247
|
options?: never;
|
|
2208
2248
|
head?: never;
|
|
2209
2249
|
/**
|
|
@@ -2247,7 +2287,11 @@ interface paths {
|
|
|
2247
2287
|
get: operations["getResource"];
|
|
2248
2288
|
put?: never;
|
|
2249
2289
|
post?: never;
|
|
2250
|
-
|
|
2290
|
+
/**
|
|
2291
|
+
* Delete a resource
|
|
2292
|
+
* @description Delete a resource. <h3>OAuth</h3>Required scopes: <code>resources</code>
|
|
2293
|
+
*/
|
|
2294
|
+
delete: operations["deleteResource"];
|
|
2251
2295
|
options?: never;
|
|
2252
2296
|
head?: never;
|
|
2253
2297
|
/**
|
|
@@ -2338,7 +2382,7 @@ interface paths {
|
|
|
2338
2382
|
};
|
|
2339
2383
|
/**
|
|
2340
2384
|
* Retrieve categories
|
|
2341
|
-
* @description Retrieve
|
|
2385
|
+
* @description Retrieve the shop categories of a location, or of every location in the network. <h3>OAuth</h3>Required scopes: <code>shop.readonly</code> or <code>shop</code>
|
|
2342
2386
|
*/
|
|
2343
2387
|
get: operations["getShopCategories"];
|
|
2344
2388
|
put?: never;
|
|
@@ -2430,7 +2474,11 @@ interface paths {
|
|
|
2430
2474
|
delete: operations["deleteProduct"];
|
|
2431
2475
|
options?: never;
|
|
2432
2476
|
head?: never;
|
|
2433
|
-
|
|
2477
|
+
/**
|
|
2478
|
+
* Partially update a product
|
|
2479
|
+
* @description Update the fields of a product that the request sets; omitted fields keep their current values. <h3>OAuth</h3>Required scopes: <code>shop</code>
|
|
2480
|
+
*/
|
|
2481
|
+
patch: operations["patchProduct"];
|
|
2434
2482
|
trace?: never;
|
|
2435
2483
|
};
|
|
2436
2484
|
"/shop/products/v1/media": {
|
|
@@ -5384,6 +5432,11 @@ interface components {
|
|
|
5384
5432
|
};
|
|
5385
5433
|
/** @description Quantity of units. */
|
|
5386
5434
|
quantity: number;
|
|
5435
|
+
/**
|
|
5436
|
+
* @description Status of the invoice the item is on: draft, issued, paid or voided. Absent for an item on no invoice.
|
|
5437
|
+
* @enum {string}
|
|
5438
|
+
*/
|
|
5439
|
+
status?: "draft" | "issued" | "paid" | "voided";
|
|
5387
5440
|
/**
|
|
5388
5441
|
* Format: uuid
|
|
5389
5442
|
* @description ID of the associated subscription.
|
|
@@ -5790,6 +5843,11 @@ interface components {
|
|
|
5790
5843
|
};
|
|
5791
5844
|
/** @description Quantity of units. */
|
|
5792
5845
|
quantity: number;
|
|
5846
|
+
/**
|
|
5847
|
+
* @description Status of the invoice the item is on: draft, issued, paid or voided. Absent for an item on no invoice.
|
|
5848
|
+
* @enum {string}
|
|
5849
|
+
*/
|
|
5850
|
+
status?: "draft" | "issued" | "paid" | "voided";
|
|
5793
5851
|
/**
|
|
5794
5852
|
* Format: uuid
|
|
5795
5853
|
* @description ID of the associated subscription.
|
|
@@ -6599,6 +6657,11 @@ interface components {
|
|
|
6599
6657
|
type: "deskBooking" | "roomBooking" | "eventTicket" | "visit" | "subscription";
|
|
6600
6658
|
/** @description The user this check-in is for, read from the users service so the details are current. */
|
|
6601
6659
|
user?: {
|
|
6660
|
+
/**
|
|
6661
|
+
* Format: date-time
|
|
6662
|
+
* @description ISO timestamp of when the user account was deleted.
|
|
6663
|
+
*/
|
|
6664
|
+
deleteDate?: string;
|
|
6602
6665
|
/** @description Email address of the user. */
|
|
6603
6666
|
email?: string | null;
|
|
6604
6667
|
/**
|
|
@@ -6724,6 +6787,11 @@ interface components {
|
|
|
6724
6787
|
type: "deskBooking" | "roomBooking" | "eventTicket" | "visit" | "subscription";
|
|
6725
6788
|
/** @description The user this check-in is for, read from the users service so the details are current. */
|
|
6726
6789
|
user?: {
|
|
6790
|
+
/**
|
|
6791
|
+
* Format: date-time
|
|
6792
|
+
* @description ISO timestamp of when the user account was deleted.
|
|
6793
|
+
*/
|
|
6794
|
+
deleteDate?: string;
|
|
6727
6795
|
/** @description Email address of the user. */
|
|
6728
6796
|
email?: string | null;
|
|
6729
6797
|
/**
|
|
@@ -10386,8 +10454,27 @@ interface components {
|
|
|
10386
10454
|
}[];
|
|
10387
10455
|
};
|
|
10388
10456
|
}[];
|
|
10457
|
+
/** @description Rescheduling policy for cancellations and start time changes. */
|
|
10458
|
+
refundPolicy: {
|
|
10459
|
+
/** @description Rescheduling policy for bookings of nonmembers. A booking follows it instead of value when it is enabled. */
|
|
10460
|
+
public: {
|
|
10461
|
+
/** @description Whether bookings of nonmembers follow a separate rescheduling policy. */
|
|
10462
|
+
enabled: boolean;
|
|
10463
|
+
/**
|
|
10464
|
+
* @description How long before start a booking of a nonmember remains refundable.
|
|
10465
|
+
* @enum {string}
|
|
10466
|
+
*/
|
|
10467
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
10468
|
+
};
|
|
10469
|
+
/**
|
|
10470
|
+
* @description How long before start a booking remains refundable.
|
|
10471
|
+
* @enum {string}
|
|
10472
|
+
*/
|
|
10473
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
10474
|
+
};
|
|
10389
10475
|
/**
|
|
10390
|
-
* @
|
|
10476
|
+
* @deprecated
|
|
10477
|
+
* @description Deprecated. Use refundPolicy.value instead.
|
|
10391
10478
|
* @enum {string}
|
|
10392
10479
|
*/
|
|
10393
10480
|
refundThreshold: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
@@ -11090,8 +11177,27 @@ interface components {
|
|
|
11090
11177
|
}[];
|
|
11091
11178
|
};
|
|
11092
11179
|
}[];
|
|
11180
|
+
/** @description Rescheduling policy for cancellations and start time changes. */
|
|
11181
|
+
refundPolicy: {
|
|
11182
|
+
/** @description Rescheduling policy for bookings of nonmembers. A booking follows it instead of value when it is enabled. */
|
|
11183
|
+
public: {
|
|
11184
|
+
/** @description Whether bookings of nonmembers follow a separate rescheduling policy. */
|
|
11185
|
+
enabled: boolean;
|
|
11186
|
+
/**
|
|
11187
|
+
* @description How long before start a booking of a nonmember remains refundable.
|
|
11188
|
+
* @enum {string}
|
|
11189
|
+
*/
|
|
11190
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
11191
|
+
};
|
|
11192
|
+
/**
|
|
11193
|
+
* @description How long before start a booking remains refundable.
|
|
11194
|
+
* @enum {string}
|
|
11195
|
+
*/
|
|
11196
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
11197
|
+
};
|
|
11093
11198
|
/**
|
|
11094
|
-
* @
|
|
11199
|
+
* @deprecated
|
|
11200
|
+
* @description Deprecated. Use refundPolicy.value instead.
|
|
11095
11201
|
* @enum {string}
|
|
11096
11202
|
*/
|
|
11097
11203
|
refundThreshold: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
@@ -11458,6 +11564,137 @@ interface components {
|
|
|
11458
11564
|
};
|
|
11459
11565
|
};
|
|
11460
11566
|
};
|
|
11567
|
+
getAssignment: {
|
|
11568
|
+
/** @description The assignment. */
|
|
11569
|
+
assignment: {
|
|
11570
|
+
/**
|
|
11571
|
+
* @deprecated
|
|
11572
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
11573
|
+
*/
|
|
11574
|
+
company?: {
|
|
11575
|
+
/**
|
|
11576
|
+
* Format: uuid
|
|
11577
|
+
* @description Company id.
|
|
11578
|
+
*/
|
|
11579
|
+
id: string;
|
|
11580
|
+
/** @description Company name. Present only for admin callers and the customer's own assignments. */
|
|
11581
|
+
title?: string;
|
|
11582
|
+
};
|
|
11583
|
+
/** @description Customer the resource is assigned to. */
|
|
11584
|
+
customer?: {
|
|
11585
|
+
/**
|
|
11586
|
+
* Format: uuid
|
|
11587
|
+
* @description Customer id.
|
|
11588
|
+
*/
|
|
11589
|
+
id: string;
|
|
11590
|
+
/** @description Company logo when the customer is a company. */
|
|
11591
|
+
logo?: {
|
|
11592
|
+
key: string;
|
|
11593
|
+
url: string;
|
|
11594
|
+
};
|
|
11595
|
+
/** @description Company name when the customer is a company. */
|
|
11596
|
+
title?: string;
|
|
11597
|
+
/**
|
|
11598
|
+
* @description Whether the customer is a user or company.
|
|
11599
|
+
* @enum {string}
|
|
11600
|
+
*/
|
|
11601
|
+
type: "user" | "company";
|
|
11602
|
+
/** @description User details when the customer is a user. */
|
|
11603
|
+
user?: {
|
|
11604
|
+
/** @description User email. */
|
|
11605
|
+
email?: string | null;
|
|
11606
|
+
/**
|
|
11607
|
+
* Format: uuid
|
|
11608
|
+
* @description User id.
|
|
11609
|
+
*/
|
|
11610
|
+
id: string;
|
|
11611
|
+
/** @description User first name. */
|
|
11612
|
+
name?: string | null;
|
|
11613
|
+
/** @description Profile photo URL. */
|
|
11614
|
+
photoUrl?: string | null;
|
|
11615
|
+
/** @description User last name. */
|
|
11616
|
+
surname?: string | null;
|
|
11617
|
+
};
|
|
11618
|
+
};
|
|
11619
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
11620
|
+
endDate?: string;
|
|
11621
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
11622
|
+
entire: boolean;
|
|
11623
|
+
/**
|
|
11624
|
+
* Format: uuid
|
|
11625
|
+
* @description Assignment id.
|
|
11626
|
+
*/
|
|
11627
|
+
id?: string;
|
|
11628
|
+
/**
|
|
11629
|
+
* @deprecated
|
|
11630
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
11631
|
+
*/
|
|
11632
|
+
membership?: {
|
|
11633
|
+
/**
|
|
11634
|
+
* Format: uuid
|
|
11635
|
+
* @description Membership id.
|
|
11636
|
+
*/
|
|
11637
|
+
id: string;
|
|
11638
|
+
};
|
|
11639
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
11640
|
+
quantity?: number;
|
|
11641
|
+
/** @description Resource the assignment belongs to. Present when assignments are listed on their own. */
|
|
11642
|
+
resource?: {
|
|
11643
|
+
/**
|
|
11644
|
+
* Format: uuid
|
|
11645
|
+
* @description Resource id.
|
|
11646
|
+
*/
|
|
11647
|
+
id: string;
|
|
11648
|
+
/** @description Resource image URL. */
|
|
11649
|
+
imageUrl?: string;
|
|
11650
|
+
/**
|
|
11651
|
+
* Format: uuid
|
|
11652
|
+
* @description UUID of the location the resource belongs to.
|
|
11653
|
+
*/
|
|
11654
|
+
locationRef: string;
|
|
11655
|
+
/** @description Resource title. */
|
|
11656
|
+
title: string;
|
|
11657
|
+
/** @description Resource type. */
|
|
11658
|
+
type: string;
|
|
11659
|
+
};
|
|
11660
|
+
/**
|
|
11661
|
+
* Format: uuid
|
|
11662
|
+
* @description UUID of the resource the assignment belongs to.
|
|
11663
|
+
*/
|
|
11664
|
+
resourceRef: string;
|
|
11665
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
11666
|
+
startDate: string;
|
|
11667
|
+
/** @description Deprecated. Use startDate and endDate instead. Subscription backing this assignment. */
|
|
11668
|
+
subscription: {
|
|
11669
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
11670
|
+
endDate?: string;
|
|
11671
|
+
/**
|
|
11672
|
+
* Format: uuid
|
|
11673
|
+
* @description Subscription id. Absent for assignments created directly by an admin.
|
|
11674
|
+
*/
|
|
11675
|
+
id?: string;
|
|
11676
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
11677
|
+
startDate: string;
|
|
11678
|
+
};
|
|
11679
|
+
/**
|
|
11680
|
+
* @deprecated
|
|
11681
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
11682
|
+
*/
|
|
11683
|
+
user?: {
|
|
11684
|
+
/** @description User email. */
|
|
11685
|
+
email?: string | null;
|
|
11686
|
+
/**
|
|
11687
|
+
* Format: uuid
|
|
11688
|
+
* @description User id.
|
|
11689
|
+
*/
|
|
11690
|
+
id: string;
|
|
11691
|
+
/** @description User first name. */
|
|
11692
|
+
name?: string | null;
|
|
11693
|
+
/** @description User last name. */
|
|
11694
|
+
surname?: string | null;
|
|
11695
|
+
};
|
|
11696
|
+
};
|
|
11697
|
+
};
|
|
11461
11698
|
createResourceMedia: {
|
|
11462
11699
|
/** @description The created media upload. */
|
|
11463
11700
|
media: {
|
|
@@ -22667,6 +22904,60 @@ interface components {
|
|
|
22667
22904
|
};
|
|
22668
22905
|
};
|
|
22669
22906
|
};
|
|
22907
|
+
patchBenefit: {
|
|
22908
|
+
content: {
|
|
22909
|
+
"application/json": {
|
|
22910
|
+
/** @description Benefit fields to change. Omitted fields keep their current values. */
|
|
22911
|
+
benefit: {
|
|
22912
|
+
/** @description Application settings. Pass the whole object; the fields inside it are not merged. */
|
|
22913
|
+
application?: {
|
|
22914
|
+
/**
|
|
22915
|
+
* @description How often a user can apply: 'once' limits to a single use, 'unlimited' allows repeated use.
|
|
22916
|
+
* @enum {string}
|
|
22917
|
+
*/
|
|
22918
|
+
allowance: "once" | "unlimited";
|
|
22919
|
+
/**
|
|
22920
|
+
* @description Label on the call-to-action button.
|
|
22921
|
+
* @enum {string}
|
|
22922
|
+
*/
|
|
22923
|
+
buttonLabel: "apply" | "buy" | "contact" | "get" | "learnMore";
|
|
22924
|
+
/** @description Confirmation email settings for applications. */
|
|
22925
|
+
confirmationEmail: {
|
|
22926
|
+
/** @description Whether a confirmation email is sent after applying. */
|
|
22927
|
+
enabled: boolean;
|
|
22928
|
+
/** @description HTML template for the confirmation email. */
|
|
22929
|
+
template: string;
|
|
22930
|
+
};
|
|
22931
|
+
/** @description Whether the application flow is enabled for this benefit. */
|
|
22932
|
+
enabled: boolean;
|
|
22933
|
+
};
|
|
22934
|
+
/**
|
|
22935
|
+
* Format: uuid
|
|
22936
|
+
* @description ID of the benefit category this benefit belongs to.
|
|
22937
|
+
*/
|
|
22938
|
+
categoryRef?: string;
|
|
22939
|
+
/** @description Full description of the benefit. */
|
|
22940
|
+
description?: string;
|
|
22941
|
+
/** @description Whether the benefit is highlighted in listings. */
|
|
22942
|
+
featured?: boolean;
|
|
22943
|
+
/** @description Media files to attach, replacing the current ones. The url is generated server-side. */
|
|
22944
|
+
media?: {
|
|
22945
|
+
/** @description Storage key of the media file, as returned by the media upload endpoint. */
|
|
22946
|
+
key: string;
|
|
22947
|
+
}[];
|
|
22948
|
+
/** @description Short tagline displayed below the title. */
|
|
22949
|
+
subtitle?: string;
|
|
22950
|
+
/** @description Display name of the benefit. */
|
|
22951
|
+
title?: string;
|
|
22952
|
+
/**
|
|
22953
|
+
* @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
|
|
22954
|
+
* @enum {string}
|
|
22955
|
+
*/
|
|
22956
|
+
visibility?: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
|
|
22957
|
+
};
|
|
22958
|
+
};
|
|
22959
|
+
};
|
|
22960
|
+
};
|
|
22670
22961
|
createBenefitMedia: {
|
|
22671
22962
|
content: {
|
|
22672
22963
|
"application/json": {
|
|
@@ -23811,15 +24102,104 @@ interface components {
|
|
|
23811
24102
|
* Format: date-time
|
|
23812
24103
|
* @description ISO timestamp of when the event starts.
|
|
23813
24104
|
*/
|
|
23814
|
-
startDate: string;
|
|
23815
|
-
/** @description Maximum number of tickets one attendee can get for the event. Omit it for unlimited. */
|
|
23816
|
-
ticketsPerAttendee?: number;
|
|
24105
|
+
startDate: string;
|
|
24106
|
+
/** @description Maximum number of tickets one attendee can get for the event. Omit it for unlimited. */
|
|
24107
|
+
ticketsPerAttendee?: number;
|
|
24108
|
+
/** @description Display name of the event. */
|
|
24109
|
+
title: string;
|
|
24110
|
+
/** @description Venue name or address within the location. */
|
|
24111
|
+
venue?: string;
|
|
24112
|
+
/**
|
|
24113
|
+
* @description Who can see this event. public: all. admins: admins only. networkMembers: network members. members: location members.
|
|
24114
|
+
* @enum {string}
|
|
24115
|
+
*/
|
|
24116
|
+
visibility?: "public" | "admins" | "networkMembers" | "members";
|
|
24117
|
+
};
|
|
24118
|
+
};
|
|
24119
|
+
};
|
|
24120
|
+
};
|
|
24121
|
+
patchEvent: {
|
|
24122
|
+
content: {
|
|
24123
|
+
"application/json": {
|
|
24124
|
+
/** @description Event fields to change. Omitted fields keep their current values. */
|
|
24125
|
+
event: {
|
|
24126
|
+
/**
|
|
24127
|
+
* @description Event application type. purchase: paid signup (requires price). none: free/RSVP-style.
|
|
24128
|
+
* @enum {string}
|
|
24129
|
+
*/
|
|
24130
|
+
applicationType?: "purchase" | "none";
|
|
24131
|
+
/** @description Confirmation email settings. */
|
|
24132
|
+
confirmationEmail?: {
|
|
24133
|
+
/** @description Whether a confirmation email is sent after registration. */
|
|
24134
|
+
enabled: boolean;
|
|
24135
|
+
/** @description HTML template for the confirmation email. */
|
|
24136
|
+
template?: string;
|
|
24137
|
+
};
|
|
24138
|
+
/** @description Custom tax settings. */
|
|
24139
|
+
customTax?: {
|
|
24140
|
+
/** @description Whether custom tax is enabled. */
|
|
24141
|
+
enabled: boolean;
|
|
24142
|
+
/** @description Custom tax rate as a decimal. */
|
|
24143
|
+
rate: number;
|
|
24144
|
+
};
|
|
24145
|
+
/** @description Full description of the event. */
|
|
24146
|
+
description?: string;
|
|
24147
|
+
/**
|
|
24148
|
+
* Format: date-time
|
|
24149
|
+
* @description ISO timestamp of when the event ends.
|
|
24150
|
+
*/
|
|
24151
|
+
endDate?: string;
|
|
24152
|
+
/** @description Limited attendees settings. */
|
|
24153
|
+
limitedAttendees?: {
|
|
24154
|
+
/** @description Whether attendee capacity is limited. */
|
|
24155
|
+
enabled: boolean;
|
|
24156
|
+
/** @description Maximum number of attendees when limited. */
|
|
24157
|
+
limit?: number;
|
|
24158
|
+
};
|
|
24159
|
+
/** @description Media files attached to the event. */
|
|
24160
|
+
media?: {
|
|
24161
|
+
/** @description Storage key of the media file, as returned by the media upload endpoint. */
|
|
24162
|
+
key?: string;
|
|
24163
|
+
/** @description Public URL of the media file. */
|
|
24164
|
+
url?: string;
|
|
24165
|
+
}[];
|
|
24166
|
+
/** @description Pricing options for the event. Can enable credits, money, or both. */
|
|
24167
|
+
price?: {
|
|
24168
|
+
/** @description Credits pricing. */
|
|
24169
|
+
credits?: {
|
|
24170
|
+
/** @description Ticket price in credits. */
|
|
24171
|
+
amount: number;
|
|
24172
|
+
/** @description Whether credits payment is enabled. */
|
|
24173
|
+
enabled: boolean;
|
|
24174
|
+
};
|
|
24175
|
+
/** @description Money pricing. */
|
|
24176
|
+
money?: {
|
|
24177
|
+
/** @description Ticket price in money. */
|
|
24178
|
+
amount: number;
|
|
24179
|
+
/** @description Whether money payment is enabled. */
|
|
24180
|
+
enabled: boolean;
|
|
24181
|
+
};
|
|
24182
|
+
};
|
|
24183
|
+
/**
|
|
24184
|
+
* @description How far in advance a refund can be requested.
|
|
24185
|
+
* @enum {string}
|
|
24186
|
+
*/
|
|
24187
|
+
refundThreshold?: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
24188
|
+
/** @description Whether the attendees list is publicly visible. */
|
|
24189
|
+
showAttendees?: boolean;
|
|
24190
|
+
/**
|
|
24191
|
+
* Format: date-time
|
|
24192
|
+
* @description ISO timestamp of when the event starts.
|
|
24193
|
+
*/
|
|
24194
|
+
startDate?: string;
|
|
24195
|
+
/** @description Maximum number of tickets one attendee can get for the event. Set it to null to make the event unlimited. */
|
|
24196
|
+
ticketsPerAttendee?: number | null;
|
|
23817
24197
|
/** @description Display name of the event. */
|
|
23818
|
-
title
|
|
24198
|
+
title?: string;
|
|
23819
24199
|
/** @description Venue name or address within the location. */
|
|
23820
24200
|
venue?: string;
|
|
23821
24201
|
/**
|
|
23822
|
-
* @description Who can see this event.
|
|
24202
|
+
* @description Who can see this event.
|
|
23823
24203
|
* @enum {string}
|
|
23824
24204
|
*/
|
|
23825
24205
|
visibility?: "public" | "admins" | "networkMembers" | "members";
|
|
@@ -23916,6 +24296,40 @@ interface components {
|
|
|
23916
24296
|
};
|
|
23917
24297
|
};
|
|
23918
24298
|
};
|
|
24299
|
+
patchFeedPost: {
|
|
24300
|
+
content: {
|
|
24301
|
+
"application/json": {
|
|
24302
|
+
/** @description Feed post fields to change. Omitted fields keep their current values. */
|
|
24303
|
+
post: {
|
|
24304
|
+
/** @description Media files, replacing the ones currently attached to the post. */
|
|
24305
|
+
media?: {
|
|
24306
|
+
/** @description Storage key of the media file. */
|
|
24307
|
+
key: string;
|
|
24308
|
+
}[];
|
|
24309
|
+
/** @description Open Graph metadata for link previews. */
|
|
24310
|
+
og?: {
|
|
24311
|
+
/** @description Open Graph description. */
|
|
24312
|
+
description?: string | null;
|
|
24313
|
+
/** @description Open Graph image URL. */
|
|
24314
|
+
image?: string | null;
|
|
24315
|
+
/** @description Open Graph title. */
|
|
24316
|
+
title?: string | null;
|
|
24317
|
+
/** @description Open Graph type. */
|
|
24318
|
+
type?: string | null;
|
|
24319
|
+
/**
|
|
24320
|
+
* Format: uri
|
|
24321
|
+
* @description Open Graph URL.
|
|
24322
|
+
*/
|
|
24323
|
+
url: string;
|
|
24324
|
+
/** @description Open Graph video URL. */
|
|
24325
|
+
videoUrl?: string | null;
|
|
24326
|
+
};
|
|
24327
|
+
/** @description Post text content. */
|
|
24328
|
+
text?: string;
|
|
24329
|
+
};
|
|
24330
|
+
};
|
|
24331
|
+
};
|
|
24332
|
+
};
|
|
23919
24333
|
createFeedPostComment: {
|
|
23920
24334
|
content: {
|
|
23921
24335
|
"application/json": {
|
|
@@ -24723,8 +25137,27 @@ interface components {
|
|
|
24723
25137
|
}[];
|
|
24724
25138
|
};
|
|
24725
25139
|
}[];
|
|
25140
|
+
/** @description Rescheduling policy. A booking takes the policy that applies to its customer when it is made. */
|
|
25141
|
+
refundPolicy?: {
|
|
25142
|
+
/** @description Rescheduling policy for bookings of nonmembers. A booking follows it instead of value when it is enabled. */
|
|
25143
|
+
public: {
|
|
25144
|
+
/** @description Whether bookings of nonmembers follow a separate rescheduling policy. */
|
|
25145
|
+
enabled: boolean;
|
|
25146
|
+
/**
|
|
25147
|
+
* @description How long before start a booking of a nonmember remains refundable.
|
|
25148
|
+
* @enum {string}
|
|
25149
|
+
*/
|
|
25150
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
25151
|
+
};
|
|
25152
|
+
/**
|
|
25153
|
+
* @description How long before start a booking remains refundable.
|
|
25154
|
+
* @enum {string}
|
|
25155
|
+
*/
|
|
25156
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
25157
|
+
};
|
|
24726
25158
|
/**
|
|
24727
|
-
* @
|
|
25159
|
+
* @deprecated
|
|
25160
|
+
* @description Deprecated. Use refundPolicy.value instead. Ignored when refundPolicy is sent.
|
|
24728
25161
|
* @enum {string}
|
|
24729
25162
|
*/
|
|
24730
25163
|
refundThreshold?: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
@@ -25206,8 +25639,27 @@ interface components {
|
|
|
25206
25639
|
}[];
|
|
25207
25640
|
};
|
|
25208
25641
|
}[];
|
|
25642
|
+
/** @description Rescheduling policy. A booking takes the policy that applies to its customer when it is made. */
|
|
25643
|
+
refundPolicy?: {
|
|
25644
|
+
/** @description Rescheduling policy for bookings of nonmembers. A booking follows it instead of value when it is enabled. */
|
|
25645
|
+
public: {
|
|
25646
|
+
/** @description Whether bookings of nonmembers follow a separate rescheduling policy. */
|
|
25647
|
+
enabled: boolean;
|
|
25648
|
+
/**
|
|
25649
|
+
* @description How long before start a booking of a nonmember remains refundable.
|
|
25650
|
+
* @enum {string}
|
|
25651
|
+
*/
|
|
25652
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
25653
|
+
};
|
|
25654
|
+
/**
|
|
25655
|
+
* @description How long before start a booking remains refundable.
|
|
25656
|
+
* @enum {string}
|
|
25657
|
+
*/
|
|
25658
|
+
value: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
25659
|
+
};
|
|
25209
25660
|
/**
|
|
25210
|
-
* @
|
|
25661
|
+
* @deprecated
|
|
25662
|
+
* @description Deprecated. Use refundPolicy.value instead. Ignored when refundPolicy is sent.
|
|
25211
25663
|
* @enum {string}
|
|
25212
25664
|
*/
|
|
25213
25665
|
refundThreshold?: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
@@ -25798,6 +26250,91 @@ interface components {
|
|
|
25798
26250
|
};
|
|
25799
26251
|
};
|
|
25800
26252
|
};
|
|
26253
|
+
patchProduct: {
|
|
26254
|
+
content: {
|
|
26255
|
+
"application/json": {
|
|
26256
|
+
/** @description Product fields to change. Omitted fields keep their current values. */
|
|
26257
|
+
product: {
|
|
26258
|
+
/**
|
|
26259
|
+
* Format: uuid
|
|
26260
|
+
* @description ID of the category this product belongs to.
|
|
26261
|
+
*/
|
|
26262
|
+
categoryRef?: string;
|
|
26263
|
+
/** @description Product description. */
|
|
26264
|
+
description?: string;
|
|
26265
|
+
/** @description Whether the product is featured. */
|
|
26266
|
+
featured?: boolean;
|
|
26267
|
+
/** @description Media files of the product, replacing the current ones. */
|
|
26268
|
+
media?: {
|
|
26269
|
+
/** @description Storage key of the media file. */
|
|
26270
|
+
key: string;
|
|
26271
|
+
}[];
|
|
26272
|
+
/** @description Purchasable options, replacing the current ones. Keep the id of every option that should survive; an option keeps the stored value of every field it omits. */
|
|
26273
|
+
options?: {
|
|
26274
|
+
/** @description Whether this option is available for purchase. */
|
|
26275
|
+
available?: boolean;
|
|
26276
|
+
/** @description Custom tax settings for this option. */
|
|
26277
|
+
customTax?: {
|
|
26278
|
+
/** @description Whether custom tax is applied to this option. */
|
|
26279
|
+
enabled?: boolean;
|
|
26280
|
+
/** @description Custom tax rate (non-negative). */
|
|
26281
|
+
rate?: number;
|
|
26282
|
+
};
|
|
26283
|
+
/** @description Option description. */
|
|
26284
|
+
description?: string;
|
|
26285
|
+
/**
|
|
26286
|
+
* Format: uuid
|
|
26287
|
+
* @description UUID of the option to change. Omit to add a new option.
|
|
26288
|
+
*/
|
|
26289
|
+
id?: string;
|
|
26290
|
+
/** @description Pricing for this option. */
|
|
26291
|
+
price?: {
|
|
26292
|
+
/** @description Credits pricing. */
|
|
26293
|
+
credits?: {
|
|
26294
|
+
/** @description Price in location credits. */
|
|
26295
|
+
amount?: number;
|
|
26296
|
+
/** @description Whether credits payment is enabled for this option. */
|
|
26297
|
+
enabled?: boolean;
|
|
26298
|
+
};
|
|
26299
|
+
/** @description Money pricing. */
|
|
26300
|
+
money?: {
|
|
26301
|
+
/** @description Price in money (location currency). */
|
|
26302
|
+
amount?: number;
|
|
26303
|
+
/** @description Whether money payment is enabled for this option. */
|
|
26304
|
+
enabled?: boolean;
|
|
26305
|
+
};
|
|
26306
|
+
};
|
|
26307
|
+
/** @description Stock settings for this option. */
|
|
26308
|
+
stock?: {
|
|
26309
|
+
/** @description Whether stock tracking is enabled. */
|
|
26310
|
+
enabled?: boolean;
|
|
26311
|
+
/** @description Units on hand when stock is enabled. */
|
|
26312
|
+
quantity?: number;
|
|
26313
|
+
};
|
|
26314
|
+
/** @description Option title. */
|
|
26315
|
+
title?: string;
|
|
26316
|
+
}[];
|
|
26317
|
+
/** @description Checkout availability settings for this product. */
|
|
26318
|
+
order?: {
|
|
26319
|
+
/** @description Whether the product can be purchased through checkout. */
|
|
26320
|
+
enabled: boolean;
|
|
26321
|
+
};
|
|
26322
|
+
/**
|
|
26323
|
+
* @description Refund policy. noRefund: purchases are final. statusNew: refunds allowed while order is in new state.
|
|
26324
|
+
* @enum {string}
|
|
26325
|
+
*/
|
|
26326
|
+
refundPolicy?: "noRefund" | "statusNew";
|
|
26327
|
+
/** @description Product title. */
|
|
26328
|
+
title?: string;
|
|
26329
|
+
/**
|
|
26330
|
+
* @description Who can see this product.
|
|
26331
|
+
* @enum {string}
|
|
26332
|
+
*/
|
|
26333
|
+
visibility?: "public" | "admins" | "members" | "networkMembers";
|
|
26334
|
+
};
|
|
26335
|
+
};
|
|
26336
|
+
};
|
|
26337
|
+
};
|
|
25801
26338
|
createProductMedia: {
|
|
25802
26339
|
content: {
|
|
25803
26340
|
"application/json": {
|
|
@@ -27514,6 +28051,45 @@ interface operations {
|
|
|
27514
28051
|
};
|
|
27515
28052
|
};
|
|
27516
28053
|
};
|
|
28054
|
+
patchBenefit: {
|
|
28055
|
+
parameters: {
|
|
28056
|
+
query?: never;
|
|
28057
|
+
header?: never;
|
|
28058
|
+
path: {
|
|
28059
|
+
/** @description The id of the benefit */
|
|
28060
|
+
benefitId: string;
|
|
28061
|
+
};
|
|
28062
|
+
cookie?: never;
|
|
28063
|
+
};
|
|
28064
|
+
requestBody: components["requestBodies"]["patchBenefit"];
|
|
28065
|
+
responses: {
|
|
28066
|
+
/** @description No Content */
|
|
28067
|
+
204: {
|
|
28068
|
+
headers: {
|
|
28069
|
+
[name: string]: unknown;
|
|
28070
|
+
};
|
|
28071
|
+
content?: never;
|
|
28072
|
+
};
|
|
28073
|
+
/** @description Bad Request */
|
|
28074
|
+
400: {
|
|
28075
|
+
headers: {
|
|
28076
|
+
[name: string]: unknown;
|
|
28077
|
+
};
|
|
28078
|
+
content: {
|
|
28079
|
+
"application/json": components["schemas"]["responseError"];
|
|
28080
|
+
};
|
|
28081
|
+
};
|
|
28082
|
+
/** @description Conflict */
|
|
28083
|
+
409: {
|
|
28084
|
+
headers: {
|
|
28085
|
+
[name: string]: unknown;
|
|
28086
|
+
};
|
|
28087
|
+
content: {
|
|
28088
|
+
"application/json": components["schemas"]["responseError"];
|
|
28089
|
+
};
|
|
28090
|
+
};
|
|
28091
|
+
};
|
|
28092
|
+
};
|
|
27517
28093
|
createBenefitMedia: {
|
|
27518
28094
|
parameters: {
|
|
27519
28095
|
query?: never;
|
|
@@ -28558,6 +29134,70 @@ interface operations {
|
|
|
28558
29134
|
};
|
|
28559
29135
|
};
|
|
28560
29136
|
};
|
|
29137
|
+
voidCreditNote: {
|
|
29138
|
+
parameters: {
|
|
29139
|
+
query?: never;
|
|
29140
|
+
header?: {
|
|
29141
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
29142
|
+
"spacebring-network-id"?: string;
|
|
29143
|
+
};
|
|
29144
|
+
path: {
|
|
29145
|
+
/** @description The id of the credit note */
|
|
29146
|
+
id: string;
|
|
29147
|
+
};
|
|
29148
|
+
cookie?: never;
|
|
29149
|
+
};
|
|
29150
|
+
requestBody?: never;
|
|
29151
|
+
responses: {
|
|
29152
|
+
/** @description OK */
|
|
29153
|
+
200: {
|
|
29154
|
+
headers: {
|
|
29155
|
+
[name: string]: unknown;
|
|
29156
|
+
};
|
|
29157
|
+
content: {
|
|
29158
|
+
"application/json": {
|
|
29159
|
+
creditNote?: components["schemas"]["creditNote"];
|
|
29160
|
+
};
|
|
29161
|
+
};
|
|
29162
|
+
};
|
|
29163
|
+
/** @description Bad Request */
|
|
29164
|
+
400: {
|
|
29165
|
+
headers: {
|
|
29166
|
+
[name: string]: unknown;
|
|
29167
|
+
};
|
|
29168
|
+
content: {
|
|
29169
|
+
"application/json": components["schemas"]["responseError"];
|
|
29170
|
+
};
|
|
29171
|
+
};
|
|
29172
|
+
/** @description Forbidden - User lacks permissions */
|
|
29173
|
+
403: {
|
|
29174
|
+
headers: {
|
|
29175
|
+
[name: string]: unknown;
|
|
29176
|
+
};
|
|
29177
|
+
content: {
|
|
29178
|
+
"application/json": components["schemas"]["responseError"];
|
|
29179
|
+
};
|
|
29180
|
+
};
|
|
29181
|
+
/** @description Not Found - Credit note not found */
|
|
29182
|
+
404: {
|
|
29183
|
+
headers: {
|
|
29184
|
+
[name: string]: unknown;
|
|
29185
|
+
};
|
|
29186
|
+
content: {
|
|
29187
|
+
"application/json": components["schemas"]["responseError"];
|
|
29188
|
+
};
|
|
29189
|
+
};
|
|
29190
|
+
/** @description Conflict - The credit note cannot be voided in its current state */
|
|
29191
|
+
409: {
|
|
29192
|
+
headers: {
|
|
29193
|
+
[name: string]: unknown;
|
|
29194
|
+
};
|
|
29195
|
+
content: {
|
|
29196
|
+
"application/json": components["schemas"]["responseError"];
|
|
29197
|
+
};
|
|
29198
|
+
};
|
|
29199
|
+
};
|
|
29200
|
+
};
|
|
28561
29201
|
previewCreditNote: {
|
|
28562
29202
|
parameters: {
|
|
28563
29203
|
query?: never;
|
|
@@ -28612,15 +29252,15 @@ interface operations {
|
|
|
28612
29252
|
};
|
|
28613
29253
|
getCheckIns: {
|
|
28614
29254
|
parameters: {
|
|
28615
|
-
query
|
|
29255
|
+
query?: {
|
|
28616
29256
|
/** @description Filter check-ins whose arrival is on or after this date (ISO 8601). Use with checkInDate[lte] for a range. */
|
|
28617
29257
|
"checkInDate[gte]"?: string;
|
|
28618
29258
|
/** @description Filter check-ins whose arrival is on or before this date (ISO 8601). Use with checkInDate[gte] for a range. */
|
|
28619
29259
|
"checkInDate[lte]"?: string;
|
|
28620
29260
|
/** @description Maximum number of check-ins per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28621
29261
|
limit?: number;
|
|
28622
|
-
/** @description UUID of the location. */
|
|
28623
|
-
locationRef
|
|
29262
|
+
/** @description UUID of the location whose check-ins to list. Omit to list check-ins across every location of the network. */
|
|
29263
|
+
locationRef?: string;
|
|
28624
29264
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
28625
29265
|
nextPageToken?: string;
|
|
28626
29266
|
/** @description Filter by status: 'scheduled' nobody has arrived yet, 'checkedIn' the person is on site, 'checkedOut' they left, 'expired' the window closed with nobody arriving. Defaults to every status. Comma-separated, one or more of: checkedIn, checkedOut, scheduled, expired. */
|
|
@@ -30302,7 +30942,7 @@ interface operations {
|
|
|
30302
30942
|
};
|
|
30303
30943
|
getEventsByOrganization: {
|
|
30304
30944
|
parameters: {
|
|
30305
|
-
query
|
|
30945
|
+
query?: {
|
|
30306
30946
|
/** @description Filter events whose create date is on or after this date (ISO 8601). */
|
|
30307
30947
|
"createDate[gte]"?: string;
|
|
30308
30948
|
/** @description Filter events whose create date is on or before this date (ISO 8601). */
|
|
@@ -30317,8 +30957,8 @@ interface operations {
|
|
|
30317
30957
|
"endDate[lte]"?: string;
|
|
30318
30958
|
/** @description Maximum number of events per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
30319
30959
|
limit?: number;
|
|
30320
|
-
/** @description UUID of the location whose events to list. */
|
|
30321
|
-
locationRef
|
|
30960
|
+
/** @description UUID of the location whose events to list. Omit to list events across every location of the network. */
|
|
30961
|
+
locationRef?: string;
|
|
30322
30962
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30323
30963
|
nextPageToken?: string;
|
|
30324
30964
|
/** @description Sort order of events. One of relevance, createDate:asc, createDate:desc, startDate:asc, startDate:desc, endDate:asc, endDate:desc. */
|
|
@@ -30517,6 +31157,48 @@ interface operations {
|
|
|
30517
31157
|
};
|
|
30518
31158
|
};
|
|
30519
31159
|
};
|
|
31160
|
+
patchEvent: {
|
|
31161
|
+
parameters: {
|
|
31162
|
+
query?: never;
|
|
31163
|
+
header?: {
|
|
31164
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31165
|
+
"spacebring-network-id"?: string;
|
|
31166
|
+
};
|
|
31167
|
+
path: {
|
|
31168
|
+
/** @description The id of the event. */
|
|
31169
|
+
id: string;
|
|
31170
|
+
};
|
|
31171
|
+
cookie?: never;
|
|
31172
|
+
};
|
|
31173
|
+
requestBody: components["requestBodies"]["patchEvent"];
|
|
31174
|
+
responses: {
|
|
31175
|
+
/** @description No Content */
|
|
31176
|
+
204: {
|
|
31177
|
+
headers: {
|
|
31178
|
+
[name: string]: unknown;
|
|
31179
|
+
};
|
|
31180
|
+
content?: never;
|
|
31181
|
+
};
|
|
31182
|
+
/** @description Bad Request */
|
|
31183
|
+
400: {
|
|
31184
|
+
headers: {
|
|
31185
|
+
[name: string]: unknown;
|
|
31186
|
+
};
|
|
31187
|
+
content: {
|
|
31188
|
+
"application/json": components["schemas"]["responseError"];
|
|
31189
|
+
};
|
|
31190
|
+
};
|
|
31191
|
+
/** @description Conflict */
|
|
31192
|
+
409: {
|
|
31193
|
+
headers: {
|
|
31194
|
+
[name: string]: unknown;
|
|
31195
|
+
};
|
|
31196
|
+
content: {
|
|
31197
|
+
"application/json": components["schemas"]["responseError"];
|
|
31198
|
+
};
|
|
31199
|
+
};
|
|
31200
|
+
};
|
|
31201
|
+
};
|
|
30520
31202
|
cancelEvent: {
|
|
30521
31203
|
parameters: {
|
|
30522
31204
|
query?: never;
|
|
@@ -30676,7 +31358,7 @@ interface operations {
|
|
|
30676
31358
|
includeDeleted?: string;
|
|
30677
31359
|
/** @description Maximum number of event tickets per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
30678
31360
|
limit?: number;
|
|
30679
|
-
/** @description UUID of the location whose event tickets to list. */
|
|
31361
|
+
/** @description UUID of the location whose event tickets to list. Omit locationRef, eventRef, customerRef and userRef to list event tickets across every location of the network. */
|
|
30680
31362
|
locationRef?: string;
|
|
30681
31363
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30682
31364
|
nextPageToken?: string;
|
|
@@ -31077,6 +31759,48 @@ interface operations {
|
|
|
31077
31759
|
};
|
|
31078
31760
|
};
|
|
31079
31761
|
};
|
|
31762
|
+
patchFeedPost: {
|
|
31763
|
+
parameters: {
|
|
31764
|
+
query?: never;
|
|
31765
|
+
header?: {
|
|
31766
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31767
|
+
"spacebring-network-id"?: string;
|
|
31768
|
+
};
|
|
31769
|
+
path: {
|
|
31770
|
+
/** @description The id of the post. */
|
|
31771
|
+
id: string;
|
|
31772
|
+
};
|
|
31773
|
+
cookie?: never;
|
|
31774
|
+
};
|
|
31775
|
+
requestBody: components["requestBodies"]["patchFeedPost"];
|
|
31776
|
+
responses: {
|
|
31777
|
+
/** @description No Content */
|
|
31778
|
+
204: {
|
|
31779
|
+
headers: {
|
|
31780
|
+
[name: string]: unknown;
|
|
31781
|
+
};
|
|
31782
|
+
content?: never;
|
|
31783
|
+
};
|
|
31784
|
+
/** @description Bad Request */
|
|
31785
|
+
400: {
|
|
31786
|
+
headers: {
|
|
31787
|
+
[name: string]: unknown;
|
|
31788
|
+
};
|
|
31789
|
+
content: {
|
|
31790
|
+
"application/json": components["schemas"]["responseError"];
|
|
31791
|
+
};
|
|
31792
|
+
};
|
|
31793
|
+
/** @description Conflict */
|
|
31794
|
+
409: {
|
|
31795
|
+
headers: {
|
|
31796
|
+
[name: string]: unknown;
|
|
31797
|
+
};
|
|
31798
|
+
content: {
|
|
31799
|
+
"application/json": components["schemas"]["responseError"];
|
|
31800
|
+
};
|
|
31801
|
+
};
|
|
31802
|
+
};
|
|
31803
|
+
};
|
|
31080
31804
|
getPostComments: {
|
|
31081
31805
|
parameters: {
|
|
31082
31806
|
query?: never;
|
|
@@ -32488,6 +33212,110 @@ interface operations {
|
|
|
32488
33212
|
};
|
|
32489
33213
|
};
|
|
32490
33214
|
};
|
|
33215
|
+
getAssignment: {
|
|
33216
|
+
parameters: {
|
|
33217
|
+
query?: never;
|
|
33218
|
+
header?: {
|
|
33219
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
33220
|
+
"spacebring-network-id"?: string;
|
|
33221
|
+
};
|
|
33222
|
+
path: {
|
|
33223
|
+
/** @description The id of the assignment. */
|
|
33224
|
+
assignmentId: string;
|
|
33225
|
+
};
|
|
33226
|
+
cookie?: never;
|
|
33227
|
+
};
|
|
33228
|
+
requestBody?: never;
|
|
33229
|
+
responses: {
|
|
33230
|
+
/** @description OK */
|
|
33231
|
+
200: {
|
|
33232
|
+
headers: {
|
|
33233
|
+
[name: string]: unknown;
|
|
33234
|
+
};
|
|
33235
|
+
content: {
|
|
33236
|
+
"application/json": components["schemas"]["getAssignment"];
|
|
33237
|
+
};
|
|
33238
|
+
};
|
|
33239
|
+
/** @description Bad Request */
|
|
33240
|
+
400: {
|
|
33241
|
+
headers: {
|
|
33242
|
+
[name: string]: unknown;
|
|
33243
|
+
};
|
|
33244
|
+
content: {
|
|
33245
|
+
"application/json": components["schemas"]["responseError"];
|
|
33246
|
+
};
|
|
33247
|
+
};
|
|
33248
|
+
/** @description Forbidden */
|
|
33249
|
+
403: {
|
|
33250
|
+
headers: {
|
|
33251
|
+
[name: string]: unknown;
|
|
33252
|
+
};
|
|
33253
|
+
content: {
|
|
33254
|
+
"application/json": components["schemas"]["responseError"];
|
|
33255
|
+
};
|
|
33256
|
+
};
|
|
33257
|
+
/** @description Not Found */
|
|
33258
|
+
404: {
|
|
33259
|
+
headers: {
|
|
33260
|
+
[name: string]: unknown;
|
|
33261
|
+
};
|
|
33262
|
+
content: {
|
|
33263
|
+
"application/json": components["schemas"]["responseError"];
|
|
33264
|
+
};
|
|
33265
|
+
};
|
|
33266
|
+
};
|
|
33267
|
+
};
|
|
33268
|
+
deleteAssignment: {
|
|
33269
|
+
parameters: {
|
|
33270
|
+
query?: never;
|
|
33271
|
+
header?: {
|
|
33272
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
33273
|
+
"spacebring-network-id"?: string;
|
|
33274
|
+
};
|
|
33275
|
+
path: {
|
|
33276
|
+
/** @description The id of the assignment. */
|
|
33277
|
+
assignmentId: string;
|
|
33278
|
+
};
|
|
33279
|
+
cookie?: never;
|
|
33280
|
+
};
|
|
33281
|
+
requestBody?: never;
|
|
33282
|
+
responses: {
|
|
33283
|
+
/** @description No Content */
|
|
33284
|
+
204: {
|
|
33285
|
+
headers: {
|
|
33286
|
+
[name: string]: unknown;
|
|
33287
|
+
};
|
|
33288
|
+
content?: never;
|
|
33289
|
+
};
|
|
33290
|
+
/** @description Bad Request */
|
|
33291
|
+
400: {
|
|
33292
|
+
headers: {
|
|
33293
|
+
[name: string]: unknown;
|
|
33294
|
+
};
|
|
33295
|
+
content: {
|
|
33296
|
+
"application/json": components["schemas"]["responseError"];
|
|
33297
|
+
};
|
|
33298
|
+
};
|
|
33299
|
+
/** @description Forbidden */
|
|
33300
|
+
403: {
|
|
33301
|
+
headers: {
|
|
33302
|
+
[name: string]: unknown;
|
|
33303
|
+
};
|
|
33304
|
+
content: {
|
|
33305
|
+
"application/json": components["schemas"]["responseError"];
|
|
33306
|
+
};
|
|
33307
|
+
};
|
|
33308
|
+
/** @description Not Found */
|
|
33309
|
+
404: {
|
|
33310
|
+
headers: {
|
|
33311
|
+
[name: string]: unknown;
|
|
33312
|
+
};
|
|
33313
|
+
content: {
|
|
33314
|
+
"application/json": components["schemas"]["responseError"];
|
|
33315
|
+
};
|
|
33316
|
+
};
|
|
33317
|
+
};
|
|
33318
|
+
};
|
|
32491
33319
|
patchAssignment: {
|
|
32492
33320
|
parameters: {
|
|
32493
33321
|
query?: never;
|
|
@@ -32606,6 +33434,57 @@ interface operations {
|
|
|
32606
33434
|
};
|
|
32607
33435
|
};
|
|
32608
33436
|
};
|
|
33437
|
+
deleteResource: {
|
|
33438
|
+
parameters: {
|
|
33439
|
+
query?: never;
|
|
33440
|
+
header?: {
|
|
33441
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
33442
|
+
"spacebring-network-id"?: string;
|
|
33443
|
+
};
|
|
33444
|
+
path: {
|
|
33445
|
+
/** @description The id of the resource. */
|
|
33446
|
+
resourceId: string;
|
|
33447
|
+
};
|
|
33448
|
+
cookie?: never;
|
|
33449
|
+
};
|
|
33450
|
+
requestBody?: never;
|
|
33451
|
+
responses: {
|
|
33452
|
+
/** @description No Content */
|
|
33453
|
+
204: {
|
|
33454
|
+
headers: {
|
|
33455
|
+
[name: string]: unknown;
|
|
33456
|
+
};
|
|
33457
|
+
content?: never;
|
|
33458
|
+
};
|
|
33459
|
+
/** @description Bad Request */
|
|
33460
|
+
400: {
|
|
33461
|
+
headers: {
|
|
33462
|
+
[name: string]: unknown;
|
|
33463
|
+
};
|
|
33464
|
+
content: {
|
|
33465
|
+
"application/json": components["schemas"]["responseError"];
|
|
33466
|
+
};
|
|
33467
|
+
};
|
|
33468
|
+
/** @description Forbidden */
|
|
33469
|
+
403: {
|
|
33470
|
+
headers: {
|
|
33471
|
+
[name: string]: unknown;
|
|
33472
|
+
};
|
|
33473
|
+
content: {
|
|
33474
|
+
"application/json": components["schemas"]["responseError"];
|
|
33475
|
+
};
|
|
33476
|
+
};
|
|
33477
|
+
/** @description Not Found */
|
|
33478
|
+
404: {
|
|
33479
|
+
headers: {
|
|
33480
|
+
[name: string]: unknown;
|
|
33481
|
+
};
|
|
33482
|
+
content: {
|
|
33483
|
+
"application/json": components["schemas"]["responseError"];
|
|
33484
|
+
};
|
|
33485
|
+
};
|
|
33486
|
+
};
|
|
33487
|
+
};
|
|
32609
33488
|
patchResource: {
|
|
32610
33489
|
parameters: {
|
|
32611
33490
|
query?: never;
|
|
@@ -32903,9 +33782,9 @@ interface operations {
|
|
|
32903
33782
|
};
|
|
32904
33783
|
getShopCategories: {
|
|
32905
33784
|
parameters: {
|
|
32906
|
-
query
|
|
32907
|
-
/** @description UUID of the location whose shop categories to list. */
|
|
32908
|
-
locationRef
|
|
33785
|
+
query?: {
|
|
33786
|
+
/** @description UUID of the location whose shop categories to list, in the order the shop shows them. Omit to list the categories of every location of the network, grouped by location. */
|
|
33787
|
+
locationRef?: string;
|
|
32909
33788
|
};
|
|
32910
33789
|
header?: {
|
|
32911
33790
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -33084,7 +33963,7 @@ interface operations {
|
|
|
33084
33963
|
id?: string;
|
|
33085
33964
|
/** @description Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
33086
33965
|
limit?: number;
|
|
33087
|
-
/** @description UUID of the location. */
|
|
33966
|
+
/** @description UUID of the location whose products to list. Omit locationRef, categoryRef and id to list products across every location of the network, newest first. */
|
|
33088
33967
|
locationRef?: string;
|
|
33089
33968
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
33090
33969
|
nextPageToken?: string;
|
|
@@ -33269,6 +34148,48 @@ interface operations {
|
|
|
33269
34148
|
};
|
|
33270
34149
|
};
|
|
33271
34150
|
};
|
|
34151
|
+
patchProduct: {
|
|
34152
|
+
parameters: {
|
|
34153
|
+
query?: never;
|
|
34154
|
+
header?: {
|
|
34155
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
34156
|
+
"spacebring-network-id"?: string;
|
|
34157
|
+
};
|
|
34158
|
+
path: {
|
|
34159
|
+
/** @description The id of the product. */
|
|
34160
|
+
productId: string;
|
|
34161
|
+
};
|
|
34162
|
+
cookie?: never;
|
|
34163
|
+
};
|
|
34164
|
+
requestBody: components["requestBodies"]["patchProduct"];
|
|
34165
|
+
responses: {
|
|
34166
|
+
/** @description No Content */
|
|
34167
|
+
204: {
|
|
34168
|
+
headers: {
|
|
34169
|
+
[name: string]: unknown;
|
|
34170
|
+
};
|
|
34171
|
+
content?: never;
|
|
34172
|
+
};
|
|
34173
|
+
/** @description Bad Request */
|
|
34174
|
+
400: {
|
|
34175
|
+
headers: {
|
|
34176
|
+
[name: string]: unknown;
|
|
34177
|
+
};
|
|
34178
|
+
content: {
|
|
34179
|
+
"application/json": components["schemas"]["responseError"];
|
|
34180
|
+
};
|
|
34181
|
+
};
|
|
34182
|
+
/** @description Conflict */
|
|
34183
|
+
409: {
|
|
34184
|
+
headers: {
|
|
34185
|
+
[name: string]: unknown;
|
|
34186
|
+
};
|
|
34187
|
+
content: {
|
|
34188
|
+
"application/json": components["schemas"]["responseError"];
|
|
34189
|
+
};
|
|
34190
|
+
};
|
|
34191
|
+
};
|
|
34192
|
+
};
|
|
33272
34193
|
createProductMedia: {
|
|
33273
34194
|
parameters: {
|
|
33274
34195
|
query?: never;
|
|
@@ -33314,7 +34235,7 @@ interface operations {
|
|
|
33314
34235
|
customerRef?: string;
|
|
33315
34236
|
/** @description Maximum number of orders per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
33316
34237
|
limit?: number;
|
|
33317
|
-
/** @description UUID of the location whose orders to list. */
|
|
34238
|
+
/** @description UUID of the location whose orders to list. Omit locationRef, customerRef and userRef to list orders across every location of the network, newest first. */
|
|
33318
34239
|
locationRef?: string;
|
|
33319
34240
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
33320
34241
|
nextPageToken?: string;
|
|
@@ -34636,13 +35557,13 @@ interface operations {
|
|
|
34636
35557
|
};
|
|
34637
35558
|
getContacts: {
|
|
34638
35559
|
parameters: {
|
|
34639
|
-
query
|
|
35560
|
+
query?: {
|
|
34640
35561
|
/** @description The maximum number of contacts to return. Default is 25. */
|
|
34641
35562
|
limit?: number;
|
|
34642
35563
|
/** @description Token to retrieve the next page of results. */
|
|
34643
35564
|
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
34644
|
-
/** @description The id of the location. */
|
|
34645
|
-
locationRef
|
|
35565
|
+
/** @description The id of the location. Omit it to list the contacts of every location in the network where the caller is an administrator. */
|
|
35566
|
+
locationRef?: string;
|
|
34646
35567
|
/** @description The create date filter of items. */
|
|
34647
35568
|
createDate?: {
|
|
34648
35569
|
/**
|
|
@@ -34763,9 +35684,9 @@ interface operations {
|
|
|
34763
35684
|
};
|
|
34764
35685
|
getRequests: {
|
|
34765
35686
|
parameters: {
|
|
34766
|
-
query
|
|
34767
|
-
/** @description The id of the location. */
|
|
34768
|
-
locationRef
|
|
35687
|
+
query?: {
|
|
35688
|
+
/** @description The id of the location. Omit it to list the pending requests of every location in the network. */
|
|
35689
|
+
locationRef?: string;
|
|
34769
35690
|
/** @description Token to retrieve the next page of results. */
|
|
34770
35691
|
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
34771
35692
|
/** @description The number of items to return. */
|
|
@@ -34960,9 +35881,9 @@ interface operations {
|
|
|
34960
35881
|
};
|
|
34961
35882
|
getVisits: {
|
|
34962
35883
|
parameters: {
|
|
34963
|
-
query
|
|
34964
|
-
/** @description The id of the location. */
|
|
34965
|
-
locationRef
|
|
35884
|
+
query?: {
|
|
35885
|
+
/** @description The id of the location. Omit it to list the visits of every location in the network, newest visit date first. */
|
|
35886
|
+
locationRef?: string;
|
|
34966
35887
|
/** @description The id of the user, host of the visit. */
|
|
34967
35888
|
userRefHost?: string;
|
|
34968
35889
|
/** @description The id of the user, visitor of the visit. */
|
|
@@ -35248,8 +36169,8 @@ interface GetContactsQuery {
|
|
|
35248
36169
|
limit?: number;
|
|
35249
36170
|
/** Token to retrieve the next page of results. */
|
|
35250
36171
|
nextPageToken?: string;
|
|
35251
|
-
/** The id of the location. */
|
|
35252
|
-
locationRef
|
|
36172
|
+
/** The id of the location. Omit it to list the contacts of every location in the network where the caller is an administrator. */
|
|
36173
|
+
locationRef?: string;
|
|
35253
36174
|
/** The create date filter of items. */
|
|
35254
36175
|
createDate?: {
|
|
35255
36176
|
lte?: string;
|
|
@@ -35258,8 +36179,8 @@ interface GetContactsQuery {
|
|
|
35258
36179
|
}
|
|
35259
36180
|
/** Query parameters for `sb.visitors.requests.list()`. */
|
|
35260
36181
|
interface GetRequestsQuery {
|
|
35261
|
-
/** The id of the location. */
|
|
35262
|
-
locationRef
|
|
36182
|
+
/** The id of the location. Omit it to list the pending requests of every location in the network. */
|
|
36183
|
+
locationRef?: string;
|
|
35263
36184
|
/** Token to retrieve the next page of results. */
|
|
35264
36185
|
nextPageToken?: string;
|
|
35265
36186
|
/** The number of items to return. */
|
|
@@ -35272,8 +36193,8 @@ interface GetRequestsQuery {
|
|
|
35272
36193
|
}
|
|
35273
36194
|
/** Query parameters for `sb.visitors.visits.list()`. */
|
|
35274
36195
|
interface GetVisitsQuery {
|
|
35275
|
-
/** The id of the location. */
|
|
35276
|
-
locationRef
|
|
36196
|
+
/** The id of the location. Omit it to list the visits of every location in the network, newest visit date first. */
|
|
36197
|
+
locationRef?: string;
|
|
35277
36198
|
/** The id of the user, host of the visit. */
|
|
35278
36199
|
userRefHost?: string;
|
|
35279
36200
|
/** The id of the user, visitor of the visit. */
|
|
@@ -35504,7 +36425,7 @@ interface GetOrdersQuery {
|
|
|
35504
36425
|
customerRef?: string;
|
|
35505
36426
|
/** Maximum number of orders per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35506
36427
|
limit?: number;
|
|
35507
|
-
/** UUID of the location whose orders to list. */
|
|
36428
|
+
/** UUID of the location whose orders to list. Omit locationRef, customerRef and userRef to list orders across every location of the network, newest first. */
|
|
35508
36429
|
locationRef?: string;
|
|
35509
36430
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35510
36431
|
nextPageToken?: string;
|
|
@@ -35523,15 +36444,15 @@ interface GetProductsQuery {
|
|
|
35523
36444
|
id?: string;
|
|
35524
36445
|
/** Maximum number of products per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35525
36446
|
limit?: number;
|
|
35526
|
-
/** UUID of the location. */
|
|
36447
|
+
/** UUID of the location whose products to list. Omit locationRef, categoryRef and id to list products across every location of the network, newest first. */
|
|
35527
36448
|
locationRef?: string;
|
|
35528
36449
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35529
36450
|
nextPageToken?: string;
|
|
35530
36451
|
}
|
|
35531
36452
|
/** Query parameters for `sb.shop.categories.list()`. */
|
|
35532
36453
|
interface GetShopCategoriesQuery {
|
|
35533
|
-
/** UUID of the location whose shop categories to list. */
|
|
35534
|
-
locationRef
|
|
36454
|
+
/** UUID of the location whose shop categories to list, in the order the shop shows them. Omit to list the categories of every location of the network, grouped by location. */
|
|
36455
|
+
locationRef?: string;
|
|
35535
36456
|
}
|
|
35536
36457
|
/** Request body for `sb.shop.products.create()`. */
|
|
35537
36458
|
type CreateProductBody = NonNullable<NonNullable<operations["createProduct"]["requestBody"]>["content"]["application/json"]["product"]>;
|
|
@@ -35539,13 +36460,15 @@ type CreateProductBody = NonNullable<NonNullable<operations["createProduct"]["re
|
|
|
35539
36460
|
type CreateProductMediaBody = NonNullable<NonNullable<operations["createProductMedia"]["requestBody"]>["content"]["application/json"]["media"]>;
|
|
35540
36461
|
/** Request body for `sb.shop.categories.create()`. */
|
|
35541
36462
|
type CreateShopCategoryBody = NonNullable<NonNullable<operations["createShopCategory"]["requestBody"]>["content"]["application/json"]["category"]>;
|
|
36463
|
+
/** Request body for `sb.shop.products.patch()`. */
|
|
36464
|
+
type PatchProductBody = NonNullable<NonNullable<operations["patchProduct"]["requestBody"]>["content"]["application/json"]["product"]>;
|
|
35542
36465
|
/** Request body for `sb.shop.products.update()`. */
|
|
35543
36466
|
type UpdateProductBody = NonNullable<NonNullable<operations["updateProduct"]["requestBody"]>["content"]["application/json"]["product"]>;
|
|
35544
36467
|
/** Request body for `sb.shop.categories.update()`. */
|
|
35545
36468
|
type UpdateShopCategoryBody = NonNullable<NonNullable<operations["updateShopCategory"]["requestBody"]>["content"]["application/json"]["category"]>;
|
|
35546
36469
|
|
|
35547
36470
|
/** A Assignment entity as returned by the Spacebring API. */
|
|
35548
|
-
type Assignment = NonNullable<operations["
|
|
36471
|
+
type Assignment = NonNullable<operations["getAssignment"]["responses"][200]["content"]["application/json"]["assignment"]>;
|
|
35549
36472
|
/** A Booking entity as returned by the Spacebring API. */
|
|
35550
36473
|
type Booking = NonNullable<operations["getBooking"]["responses"][200]["content"]["application/json"]["booking"]>;
|
|
35551
36474
|
/** A GetResourceAvailability entity as returned by the Spacebring API. */
|
|
@@ -35755,6 +36678,8 @@ type CreateFeedPostBody = NonNullable<NonNullable<operations["createFeedPost"]["
|
|
|
35755
36678
|
type CreateFeedPostCommentBody = NonNullable<NonNullable<operations["createFeedPostComment"]["requestBody"]>["content"]["application/json"]["comment"]>;
|
|
35756
36679
|
/** Request body for `sb.feed.createMedia()`. */
|
|
35757
36680
|
type CreateFeedPostMediaBody = NonNullable<NonNullable<operations["createFeedPostMedia"]["requestBody"]>["content"]["application/json"]["media"]>;
|
|
36681
|
+
/** Request body for `sb.feed.posts.patch()`. */
|
|
36682
|
+
type PatchFeedPostBody = NonNullable<NonNullable<operations["patchFeedPost"]["requestBody"]>["content"]["application/json"]["post"]>;
|
|
35758
36683
|
/** Request body for `sb.feed.posts.update()`. */
|
|
35759
36684
|
type UpdateFeedPostBody = NonNullable<NonNullable<operations["updateFeedPost"]["requestBody"]>["content"]["application/json"]["post"]>;
|
|
35760
36685
|
|
|
@@ -35780,8 +36705,8 @@ interface GetEventsByOrganizationQuery {
|
|
|
35780
36705
|
"endDate[lte]"?: string;
|
|
35781
36706
|
/** Maximum number of events per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35782
36707
|
limit?: number;
|
|
35783
|
-
/** UUID of the location whose events to list. */
|
|
35784
|
-
locationRef
|
|
36708
|
+
/** UUID of the location whose events to list. Omit to list events across every location of the network. */
|
|
36709
|
+
locationRef?: string;
|
|
35785
36710
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35786
36711
|
nextPageToken?: string;
|
|
35787
36712
|
/** Sort order of events. One of relevance, createDate:asc, createDate:desc, startDate:asc, startDate:desc, endDate:asc, endDate:desc. */
|
|
@@ -35805,7 +36730,7 @@ interface GetEventTicketsQuery {
|
|
|
35805
36730
|
includeDeleted?: string;
|
|
35806
36731
|
/** Maximum number of event tickets per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35807
36732
|
limit?: number;
|
|
35808
|
-
/** UUID of the location whose event tickets to list. */
|
|
36733
|
+
/** UUID of the location whose event tickets to list. Omit locationRef, eventRef, customerRef and userRef to list event tickets across every location of the network. */
|
|
35809
36734
|
locationRef?: string;
|
|
35810
36735
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35811
36736
|
nextPageToken?: string;
|
|
@@ -35820,6 +36745,8 @@ type AddEventHostsBody = NonNullable<NonNullable<operations["addEventHosts"]["re
|
|
|
35820
36745
|
type CreateEventBody = NonNullable<NonNullable<operations["createEvent"]["requestBody"]>["content"]["application/json"]["event"]>;
|
|
35821
36746
|
/** Request body for `sb.events.createMedia()`. */
|
|
35822
36747
|
type CreateEventMediaBody = NonNullable<NonNullable<operations["createEventMedia"]["requestBody"]>["content"]["application/json"]["media"]>;
|
|
36748
|
+
/** Request body for `sb.events.patch()`. */
|
|
36749
|
+
type PatchEventBody = NonNullable<NonNullable<operations["patchEvent"]["requestBody"]>["content"]["application/json"]["event"]>;
|
|
35823
36750
|
/** Request body for `sb.events.update()`. */
|
|
35824
36751
|
type UpdateEventBody = NonNullable<NonNullable<operations["updateEvent"]["requestBody"]>["content"]["application/json"]["event"]>;
|
|
35825
36752
|
/** Request body for `sb.events.tickets.update()`. */
|
|
@@ -35986,8 +36913,8 @@ interface GetCheckInsQuery {
|
|
|
35986
36913
|
"checkInDate[lte]"?: string;
|
|
35987
36914
|
/** Maximum number of check-ins per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
35988
36915
|
limit?: number;
|
|
35989
|
-
/** UUID of the location. */
|
|
35990
|
-
locationRef
|
|
36916
|
+
/** UUID of the location whose check-ins to list. Omit to list check-ins across every location of the network. */
|
|
36917
|
+
locationRef?: string;
|
|
35991
36918
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
35992
36919
|
nextPageToken?: string;
|
|
35993
36920
|
/** Filter by status: 'scheduled' nobody has arrived yet, 'checkedIn' the person is on site, 'checkedOut' they left, 'expired' the window closed with nobody arriving. Defaults to every status. Comma-separated, one or more of: checkedIn, checkedOut, scheduled, expired. */
|
|
@@ -36171,6 +37098,8 @@ type CreateBenefitBody = NonNullable<NonNullable<operations["createBenefit"]["re
|
|
|
36171
37098
|
type CreateBenefitCategoryBody = NonNullable<NonNullable<operations["createBenefitCategory"]["requestBody"]>["content"]["application/json"]["category"]>;
|
|
36172
37099
|
/** Request body for `sb.benefits.createMedia()`. */
|
|
36173
37100
|
type CreateBenefitMediaBody = NonNullable<NonNullable<operations["createBenefitMedia"]["requestBody"]>["content"]["application/json"]["media"]>;
|
|
37101
|
+
/** Request body for `sb.benefits.patch()`. */
|
|
37102
|
+
type PatchBenefitBody = NonNullable<NonNullable<operations["patchBenefit"]["requestBody"]>["content"]["application/json"]["benefit"]>;
|
|
36174
37103
|
/** Request body for `sb.benefits.update()`. */
|
|
36175
37104
|
type UpdateBenefitBody = NonNullable<NonNullable<operations["updateBenefit"]["requestBody"]>["content"]["application/json"]["benefit"]>;
|
|
36176
37105
|
/** Request body for `sb.benefits.categories.update()`. */
|
|
@@ -36217,6 +37146,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36217
37146
|
update(benefitId: string, benefit: UpdateBenefitBody, options?: SpacebringRequestOptions): Promise<Benefit>;
|
|
36218
37147
|
delete(benefitId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36219
37148
|
createMedia(media: CreateBenefitMediaBody, options?: SpacebringRequestOptions): Promise<BenefitMedia>;
|
|
37149
|
+
patch(benefitId: string, benefit: PatchBenefitBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36220
37150
|
applications: {
|
|
36221
37151
|
list(query?: GetBenefitApplicationsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36222
37152
|
applications: Application[];
|
|
@@ -36247,6 +37177,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36247
37177
|
create(creditNote: CreateCreditNoteBody, options?: SpacebringRequestOptions): Promise<CreditNote>;
|
|
36248
37178
|
update(id: string, creditNote: UpdateCreditNoteBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36249
37179
|
preview(creditNote: PreviewCreditNoteBody, options?: SpacebringRequestOptions): Promise<CreditNote>;
|
|
37180
|
+
void(id: string, options?: SpacebringRequestOptions): Promise<CreditNote>;
|
|
36250
37181
|
};
|
|
36251
37182
|
invoices: {
|
|
36252
37183
|
list(query?: GetInvoicesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
@@ -36292,12 +37223,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36292
37223
|
};
|
|
36293
37224
|
};
|
|
36294
37225
|
checkIns: {
|
|
36295
|
-
list(query
|
|
37226
|
+
list(query?: GetCheckInsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36296
37227
|
checkIns: CheckIn[];
|
|
36297
37228
|
nextPageToken?: string;
|
|
36298
37229
|
searchQueryNext?: string;
|
|
36299
37230
|
}>;
|
|
36300
|
-
iterate(query
|
|
37231
|
+
iterate(query?: Omit<GetCheckInsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CheckIn, void, undefined>;
|
|
36301
37232
|
get(checkInId: string, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
36302
37233
|
checkIn(body: CheckInBody, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
36303
37234
|
checkOut(body: CheckOutBody, options?: SpacebringRequestOptions): Promise<CheckIn>;
|
|
@@ -36390,7 +37321,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36390
37321
|
};
|
|
36391
37322
|
};
|
|
36392
37323
|
events: {
|
|
36393
|
-
list(query
|
|
37324
|
+
list(query?: GetEventsByOrganizationQuery, options?: SpacebringRequestOptions): Promise<operations["getEventsByOrganization"]["responses"][200]["content"]["application/json"]>;
|
|
36394
37325
|
get(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
36395
37326
|
create(event: CreateEventBody, options?: SpacebringRequestOptions): Promise<Event>;
|
|
36396
37327
|
update(id: string, event: UpdateEventBody, options?: SpacebringRequestOptions): Promise<Event>;
|
|
@@ -36399,6 +37330,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36399
37330
|
cancel(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
36400
37331
|
copy(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
36401
37332
|
createMedia(media: CreateEventMediaBody, options?: SpacebringRequestOptions): Promise<EventMedia>;
|
|
37333
|
+
patch(id: string, event: PatchEventBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36402
37334
|
tickets: {
|
|
36403
37335
|
list(query?: GetEventTicketsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36404
37336
|
tickets?: EventTicket[];
|
|
@@ -36435,6 +37367,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36435
37367
|
deleteLike(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36436
37368
|
getComments(id: string, options?: SpacebringRequestOptions): Promise<Comment[]>;
|
|
36437
37369
|
getLikes(id: string, options?: SpacebringRequestOptions): Promise<Like[]>;
|
|
37370
|
+
patch(id: string, post: PatchFeedPostBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36438
37371
|
};
|
|
36439
37372
|
};
|
|
36440
37373
|
floors: {
|
|
@@ -36504,6 +37437,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36504
37437
|
get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
36505
37438
|
create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
36506
37439
|
update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
37440
|
+
delete(resourceId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36507
37441
|
createMedia(media: CreateResourceMediaBody, options?: SpacebringRequestOptions): Promise<ResourceMedia>;
|
|
36508
37442
|
getResourceAvailability(resourceId: string, body: GetResourceAvailabilityBody, options?: SpacebringRequestOptions): Promise<GetResourceAvailability>;
|
|
36509
37443
|
assignments: {
|
|
@@ -36513,8 +37447,10 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36513
37447
|
searchQueryNext?: string;
|
|
36514
37448
|
}>;
|
|
36515
37449
|
iterate(query?: Omit<GetAssignmentsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Assignment, void, undefined>;
|
|
37450
|
+
get(assignmentId: string, options?: SpacebringRequestOptions): Promise<Assignment>;
|
|
36516
37451
|
create(assignment: CreateAssignmentBody, options?: SpacebringRequestOptions): Promise<Assignment>;
|
|
36517
37452
|
update(assignmentId: string, assignment: PatchAssignmentBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
37453
|
+
delete(assignmentId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36518
37454
|
};
|
|
36519
37455
|
bookings: {
|
|
36520
37456
|
list(query?: GetBookingsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
@@ -36531,7 +37467,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36531
37467
|
};
|
|
36532
37468
|
shop: {
|
|
36533
37469
|
categories: {
|
|
36534
|
-
list(query
|
|
37470
|
+
list(query?: GetShopCategoriesQuery, options?: SpacebringRequestOptions): Promise<ShopCategory[]>;
|
|
36535
37471
|
get(categoryId: string, options?: SpacebringRequestOptions): Promise<ShopCategory>;
|
|
36536
37472
|
create(category: CreateShopCategoryBody, options?: SpacebringRequestOptions): Promise<ShopCategory>;
|
|
36537
37473
|
update(categoryId: string, category: UpdateShopCategoryBody, options?: SpacebringRequestOptions): Promise<ShopCategory>;
|
|
@@ -36558,6 +37494,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36558
37494
|
update(productId: string, product: UpdateProductBody, options?: SpacebringRequestOptions): Promise<Product>;
|
|
36559
37495
|
delete(productId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36560
37496
|
createMedia(media: CreateProductMediaBody, options?: SpacebringRequestOptions): Promise<ProductMedia>;
|
|
37497
|
+
patch(productId: string, product: PatchProductBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36561
37498
|
};
|
|
36562
37499
|
};
|
|
36563
37500
|
subscriptions: {
|
|
@@ -36664,34 +37601,34 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
36664
37601
|
};
|
|
36665
37602
|
visitors: {
|
|
36666
37603
|
contacts: {
|
|
36667
|
-
list(query
|
|
37604
|
+
list(query?: GetContactsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36668
37605
|
contacts?: Contact[];
|
|
36669
37606
|
nextPageToken?: string;
|
|
36670
37607
|
searchQueryNext?: string;
|
|
36671
37608
|
}>;
|
|
36672
|
-
iterate(query
|
|
37609
|
+
iterate(query?: Omit<GetContactsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Contact, void, undefined>;
|
|
36673
37610
|
get(contactId: string, options?: SpacebringRequestOptions): Promise<Contact>;
|
|
36674
37611
|
create(contact: CreateContactBody, options?: SpacebringRequestOptions): Promise<Contact>;
|
|
36675
37612
|
};
|
|
36676
37613
|
requests: {
|
|
36677
|
-
list(query
|
|
37614
|
+
list(query?: GetRequestsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36678
37615
|
nextPageToken?: string;
|
|
36679
37616
|
requests?: Request$1[];
|
|
36680
37617
|
searchQueryNext?: string;
|
|
36681
37618
|
}>;
|
|
36682
|
-
iterate(query
|
|
37619
|
+
iterate(query?: Omit<GetRequestsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Request$1, void, undefined>;
|
|
36683
37620
|
get(id: string, options?: SpacebringRequestOptions): Promise<Request$1>;
|
|
36684
37621
|
create(request: CreateRequestBody, options?: SpacebringRequestOptions): Promise<Request$1>;
|
|
36685
37622
|
approve(id: string, options?: SpacebringRequestOptions): Promise<Visit>;
|
|
36686
37623
|
reject(id: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
36687
37624
|
};
|
|
36688
37625
|
visits: {
|
|
36689
|
-
list(query
|
|
37626
|
+
list(query?: GetVisitsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
36690
37627
|
nextPageToken?: string;
|
|
36691
37628
|
searchQueryNext?: string;
|
|
36692
37629
|
visits?: Visit[];
|
|
36693
37630
|
}>;
|
|
36694
|
-
iterate(query
|
|
37631
|
+
iterate(query?: Omit<GetVisitsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Visit, void, undefined>;
|
|
36695
37632
|
get(id: string, options?: SpacebringRequestOptions): Promise<Visit>;
|
|
36696
37633
|
create(visit: CreateVisitBody, options?: SpacebringRequestOptions): Promise<Visit>;
|
|
36697
37634
|
update(id: string, visit: UpdateVisitBody, options?: SpacebringRequestOptions): Promise<Visit>;
|
|
@@ -36760,4 +37697,5 @@ declare class SpacebringError extends Error {
|
|
|
36760
37697
|
});
|
|
36761
37698
|
}
|
|
36762
37699
|
|
|
36763
|
-
export {
|
|
37700
|
+
export { Spacebring, SpacebringError };
|
|
37701
|
+
export type { Activity, AddEventHostsBody, AltCurrency, Application, ApplyBenefitBody, Assignment, Attachment, Balance, Benefit, BenefitCategory, BenefitMedia, Booking, CheckIn, CheckInBody, CheckInVisitBody, CheckOutBody, CheckOutVisitBody, Comment, Company, CompanyMedia, Contact, Contract, Coupon, CreateAltCurrencyBody, CreateAssignmentBody, CreateBenefitBody, CreateBenefitCategoryBody, CreateBenefitMediaBody, CreateBookingBody, CreateCompanyBody, CreateCompanyMediaBody, CreateContactBody, CreateContractBody, CreateCouponBody, CreateCreditNoteBody, CreateCreditsTransactionBody, CreateDayPassesTransactionBody, CreateEventBody, CreateEventMediaBody, CreateFeedPostBody, CreateFeedPostCommentBody, CreateFeedPostMediaBody, CreateGuideAttachmentBody, CreateGuideBody, CreateGuideMediaBody, CreateInvoiceBody, CreateInvoiceItemBody, CreateMembershipBody, CreateMoneyTransactionBody, CreatePackageBody, CreatePlanBody, CreateProductBody, CreateProductMediaBody, CreatePromocodeBody, CreateRequestBody, CreateResourceBody, CreateResourceMediaBody, CreateShopCategoryBody, CreateSubscriptionBody, CreateSubscriptionItemBody, CreateSupportTicketBody, CreateSupportTicketCommentBody, CreateSupportTicketMediaBody, CreateTemplateBody, CreateTemplateMediaBody, CreateVisitBody, CreditNote, CreditScheduledTransaction, CreditTransaction, DayPassScheduledTransaction, DayPassTransaction, Event, EventMedia, EventTicket, FeedMedia, GetAltCurrenciesQuery, GetAssignmentsQuery, GetBenefitApplicationsQuery, GetBenefitCategoriesQuery, GetBenefitsQuery, GetBookingsQuery, GetCheckInsQuery, GetCompaniesQuery, GetContactsQuery, GetContractsQuery, GetCouponsQuery, GetCreditNotesQuery, GetCreditsTransactionsQuery, GetDayPassesTransactionsQuery, GetDiscountRedemptionsQuery, GetEventTicketsQuery, GetEventsByOrganizationQuery, GetFeedPostsQuery, GetFloorsQuery, GetGuidesQuery, GetInvoicesQuery, GetMembershipsDeletedQuery, GetMembershipsQuery, GetMoneyTransactionsQuery, GetOrdersQuery, GetPackagesQuery, GetPlansQuery, GetProductsQuery, GetPromocodesQuery, GetRegistrationsQuery, GetRequestsQuery, GetResourceAvailability, GetResourceAvailabilityBody, GetResourcesQuery, GetScheduledCreditsTransactionsQuery, GetScheduledDayPassesTransactionsQuery, GetShopCategoriesQuery, GetSubscriptionsQuery, GetSupportTicketsQuery, GetTemplatesQuery, GetUpcomingInvoiceItemsQuery, GetUpcomingInvoiceQuery, GetVisitsQuery, Guide, GuideMedia, Invoice, InvoiceItem, IssueContractBody, IssueInvoiceBody, Like, ListInvoiceItemsQuery, Location, Membership, MoneyTransaction, Network, Order, Package, PatchAssignmentBody, PatchBenefitBody, PatchBookingBody, PatchEventBody, PatchFeedPostBody, PatchGuideBody, PatchMoneyTransactionBody, PatchPackageBody, PatchProductBody, PatchResourceBody, PayInvoiceBody, Payment, Plan, Post, PreviewCreditNoteBody, Product, ProductMedia, Promocode, Redemption, Refund, RefundMoneyTransactionBody, Registration, Request$1 as Request, Resource, ResourceMedia, ShopCategory, SpacebringConfig, SpacebringErrorBody, SpacebringRequestOptions, SpacebringResources, Subscription, SupportTicket, Template, TemplateMedia, TerminateContractBody, TicketMedia, UpcomingItem, UpdateAltCurrencyBody, UpdateBenefitBody, UpdateBenefitCategoryBody, UpdateCompanyBody, UpdateContractBody, UpdateCouponBody, UpdateCreditNoteBody, UpdateEventBody, UpdateEventTicketBody, UpdateFeedPostBody, UpdateInvoiceBody, UpdateInvoiceItemBody, UpdateMembershipBody, UpdatePlanBody, UpdateProductBody, UpdateShopCategoryBody, UpdateSubscriptionBody, UpdateSubscriptionItemBody, UpdateSupportTicketAssigneeBody, UpdateSupportTicketCommentBody, UpdateSupportTicketStatusBody, UpdateSupportTicketTypeBody, UpdateTemplateBody, UpdateVisitBody, Visit, components, operations, paths };
|