@izak0s/spacebring-api 5.5.0 → 6.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 +12 -12
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1753 -670
- package/dist/index.d.ts +1753 -670
- package/dist/index.js +12 -12
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1979,7 +1979,7 @@ interface paths {
|
|
|
1979
1979
|
patch?: never;
|
|
1980
1980
|
trace?: never;
|
|
1981
1981
|
};
|
|
1982
|
-
"/resources/v1/{
|
|
1982
|
+
"/resources/v1/{resourceId}": {
|
|
1983
1983
|
parameters: {
|
|
1984
1984
|
query?: never;
|
|
1985
1985
|
header?: never;
|
|
@@ -2027,7 +2027,7 @@ interface paths {
|
|
|
2027
2027
|
patch?: never;
|
|
2028
2028
|
trace?: never;
|
|
2029
2029
|
};
|
|
2030
|
-
"/resources/bookings/v1/{
|
|
2030
|
+
"/resources/bookings/v1/{bookingId}": {
|
|
2031
2031
|
parameters: {
|
|
2032
2032
|
query?: never;
|
|
2033
2033
|
header?: never;
|
|
@@ -3050,10 +3050,10 @@ interface components {
|
|
|
3050
3050
|
*/
|
|
3051
3051
|
updateDate?: string;
|
|
3052
3052
|
/**
|
|
3053
|
-
* @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
|
|
3053
|
+
* @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
|
|
3054
3054
|
* @enum {string}
|
|
3055
3055
|
*/
|
|
3056
|
-
visibility: "public" | "admins" | "members" | "networkMembers";
|
|
3056
|
+
visibility: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
|
|
3057
3057
|
}[];
|
|
3058
3058
|
/** @description Pagination token to fetch the next page of results. */
|
|
3059
3059
|
nextPageToken?: string;
|
|
@@ -3130,10 +3130,10 @@ interface components {
|
|
|
3130
3130
|
*/
|
|
3131
3131
|
updateDate?: string;
|
|
3132
3132
|
/**
|
|
3133
|
-
* @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
|
|
3133
|
+
* @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
|
|
3134
3134
|
* @enum {string}
|
|
3135
3135
|
*/
|
|
3136
|
-
visibility: "public" | "admins" | "members" | "networkMembers";
|
|
3136
|
+
visibility: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
|
|
3137
3137
|
};
|
|
3138
3138
|
getBenefit: {
|
|
3139
3139
|
/** @description The benefit. */
|
|
@@ -3207,10 +3207,10 @@ interface components {
|
|
|
3207
3207
|
*/
|
|
3208
3208
|
updateDate?: string;
|
|
3209
3209
|
/**
|
|
3210
|
-
* @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
|
|
3210
|
+
* @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
|
|
3211
3211
|
* @enum {string}
|
|
3212
3212
|
*/
|
|
3213
|
-
visibility: "public" | "admins" | "members" | "networkMembers";
|
|
3213
|
+
visibility: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
|
|
3214
3214
|
};
|
|
3215
3215
|
};
|
|
3216
3216
|
getBenefitApplications: {
|
|
@@ -3633,8 +3633,6 @@ interface components {
|
|
|
3633
3633
|
* @enum {string}
|
|
3634
3634
|
*/
|
|
3635
3635
|
dueType?: "date" | "days" | "default";
|
|
3636
|
-
/** @description URL of the public invoice page, where the invoice can be viewed, downloaded and paid without signing in (issued invoices only). */
|
|
3637
|
-
hostedInvoiceUrl?: string;
|
|
3638
3636
|
/**
|
|
3639
3637
|
* Format: uuid
|
|
3640
3638
|
* @description Unique identifier of the invoice.
|
|
@@ -4032,8 +4030,6 @@ interface components {
|
|
|
4032
4030
|
* @enum {string}
|
|
4033
4031
|
*/
|
|
4034
4032
|
dueType?: "date" | "days" | "default";
|
|
4035
|
-
/** @description URL of the public invoice page, where the invoice can be viewed, downloaded and paid without signing in (issued invoices only). */
|
|
4036
|
-
hostedInvoiceUrl?: string;
|
|
4037
4033
|
/**
|
|
4038
4034
|
* Format: uuid
|
|
4039
4035
|
* @description Unique identifier of the invoice.
|
|
@@ -4428,8 +4424,6 @@ interface components {
|
|
|
4428
4424
|
* @enum {string}
|
|
4429
4425
|
*/
|
|
4430
4426
|
dueType?: "date" | "days" | "default";
|
|
4431
|
-
/** @description URL of the public invoice page, where the invoice can be viewed, downloaded and paid without signing in (issued invoices only). */
|
|
4432
|
-
hostedInvoiceUrl?: string;
|
|
4433
4427
|
/**
|
|
4434
4428
|
* Format: uuid
|
|
4435
4429
|
* @description Unique identifier of the invoice.
|
|
@@ -8060,8 +8054,10 @@ interface components {
|
|
|
8060
8054
|
/** @description Discount percentage for shop products. */
|
|
8061
8055
|
shop: number;
|
|
8062
8056
|
};
|
|
8063
|
-
/** @description Resources exclusively available to members on this plan. */
|
|
8057
|
+
/** @description Resources and benefits exclusively available to members on this plan. */
|
|
8064
8058
|
exclusiveAccess: {
|
|
8059
|
+
/** @description Benefit IDs with exclusive access for this plan. */
|
|
8060
|
+
benefitRefs: string[];
|
|
8065
8061
|
/** @description Resource IDs with exclusive access for this plan. */
|
|
8066
8062
|
resourceRefs: string[];
|
|
8067
8063
|
};
|
|
@@ -8229,8 +8225,10 @@ interface components {
|
|
|
8229
8225
|
/** @description Discount percentage for shop products. */
|
|
8230
8226
|
shop: number;
|
|
8231
8227
|
};
|
|
8232
|
-
/** @description Resources exclusively available to members on this plan. */
|
|
8228
|
+
/** @description Resources and benefits exclusively available to members on this plan. */
|
|
8233
8229
|
exclusiveAccess: {
|
|
8230
|
+
/** @description Benefit IDs with exclusive access for this plan. */
|
|
8231
|
+
benefitRefs: string[];
|
|
8234
8232
|
/** @description Resource IDs with exclusive access for this plan. */
|
|
8235
8233
|
resourceRefs: string[];
|
|
8236
8234
|
};
|
|
@@ -8397,8 +8395,10 @@ interface components {
|
|
|
8397
8395
|
/** @description Discount percentage for shop products. */
|
|
8398
8396
|
shop: number;
|
|
8399
8397
|
};
|
|
8400
|
-
/** @description Resources exclusively available to members on this plan. */
|
|
8398
|
+
/** @description Resources and benefits exclusively available to members on this plan. */
|
|
8401
8399
|
exclusiveAccess: {
|
|
8400
|
+
/** @description Benefit IDs with exclusive access for this plan. */
|
|
8401
|
+
benefitRefs: string[];
|
|
8402
8402
|
/** @description Resource IDs with exclusive access for this plan. */
|
|
8403
8403
|
resourceRefs: string[];
|
|
8404
8404
|
};
|
|
@@ -8593,334 +8593,293 @@ interface components {
|
|
|
8593
8593
|
surname?: string | null;
|
|
8594
8594
|
};
|
|
8595
8595
|
};
|
|
8596
|
-
|
|
8597
|
-
/** @description
|
|
8598
|
-
|
|
8599
|
-
|
|
8600
|
-
|
|
8596
|
+
getResources: {
|
|
8597
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
8598
|
+
nextPageToken?: string;
|
|
8599
|
+
/** @description List of resources. */
|
|
8600
|
+
resources: {
|
|
8601
|
+
/** @description Active resource assignments. */
|
|
8602
|
+
assignments: {
|
|
8603
|
+
/**
|
|
8604
|
+
* @deprecated
|
|
8605
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
8606
|
+
*/
|
|
8607
|
+
company?: {
|
|
8608
|
+
/**
|
|
8609
|
+
* Format: uuid
|
|
8610
|
+
* @description Company id.
|
|
8611
|
+
*/
|
|
8612
|
+
id: string;
|
|
8613
|
+
/** @description Company name. */
|
|
8614
|
+
title: string;
|
|
8615
|
+
};
|
|
8616
|
+
/** @description Customer the resource is assigned to. */
|
|
8617
|
+
customer?: {
|
|
8618
|
+
/**
|
|
8619
|
+
* Format: uuid
|
|
8620
|
+
* @description Customer id.
|
|
8621
|
+
*/
|
|
8622
|
+
id: string;
|
|
8623
|
+
/** @description Company name when the customer is a company. */
|
|
8624
|
+
title?: string;
|
|
8625
|
+
/**
|
|
8626
|
+
* @description Whether the customer is a user or company.
|
|
8627
|
+
* @enum {string}
|
|
8628
|
+
*/
|
|
8629
|
+
type: "user" | "company";
|
|
8630
|
+
/** @description User details when the customer is a user. */
|
|
8631
|
+
user?: {
|
|
8632
|
+
/** @description User email. */
|
|
8633
|
+
email?: string | null;
|
|
8634
|
+
/**
|
|
8635
|
+
* Format: uuid
|
|
8636
|
+
* @description User id.
|
|
8637
|
+
*/
|
|
8638
|
+
id: string;
|
|
8639
|
+
/** @description User first name. */
|
|
8640
|
+
name?: string | null;
|
|
8641
|
+
/** @description User last name. */
|
|
8642
|
+
surname?: string | null;
|
|
8643
|
+
};
|
|
8644
|
+
};
|
|
8645
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
8646
|
+
entire: boolean;
|
|
8601
8647
|
/**
|
|
8602
8648
|
* Format: uuid
|
|
8603
|
-
* @description
|
|
8649
|
+
* @description Assignment id.
|
|
8604
8650
|
*/
|
|
8605
|
-
id
|
|
8606
|
-
/**
|
|
8607
|
-
|
|
8608
|
-
|
|
8609
|
-
|
|
8610
|
-
|
|
8611
|
-
|
|
8612
|
-
|
|
8613
|
-
|
|
8614
|
-
|
|
8615
|
-
|
|
8616
|
-
|
|
8617
|
-
|
|
8651
|
+
id?: string;
|
|
8652
|
+
/**
|
|
8653
|
+
* @deprecated
|
|
8654
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
8655
|
+
*/
|
|
8656
|
+
membership?: {
|
|
8657
|
+
/**
|
|
8658
|
+
* Format: uuid
|
|
8659
|
+
* @description Membership id.
|
|
8660
|
+
*/
|
|
8661
|
+
id: string;
|
|
8662
|
+
};
|
|
8663
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
8664
|
+
quantity?: number;
|
|
8618
8665
|
/**
|
|
8619
8666
|
* Format: uuid
|
|
8620
|
-
* @description
|
|
8667
|
+
* @description UUID of the resource the assignment belongs to.
|
|
8621
8668
|
*/
|
|
8622
|
-
|
|
8669
|
+
resourceRef: string;
|
|
8670
|
+
/** @description Subscription backing this assignment. */
|
|
8671
|
+
subscription: {
|
|
8672
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
8673
|
+
endDate?: string;
|
|
8674
|
+
/**
|
|
8675
|
+
* Format: uuid
|
|
8676
|
+
* @description Subscription id.
|
|
8677
|
+
*/
|
|
8678
|
+
id: string;
|
|
8679
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
8680
|
+
startDate: string;
|
|
8681
|
+
};
|
|
8682
|
+
/**
|
|
8683
|
+
* @deprecated
|
|
8684
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
8685
|
+
*/
|
|
8686
|
+
user?: {
|
|
8687
|
+
/** @description User email. */
|
|
8688
|
+
email?: string | null;
|
|
8689
|
+
/**
|
|
8690
|
+
* Format: uuid
|
|
8691
|
+
* @description User id.
|
|
8692
|
+
*/
|
|
8693
|
+
id: string;
|
|
8694
|
+
/** @description User first name. */
|
|
8695
|
+
name?: string | null;
|
|
8696
|
+
/** @description User last name. */
|
|
8697
|
+
surname?: string | null;
|
|
8698
|
+
};
|
|
8699
|
+
}[];
|
|
8700
|
+
/** @description Auto-release settings for no-show bookings. */
|
|
8701
|
+
autoRelease?: {
|
|
8702
|
+
/** @description Whether auto-release is enabled. */
|
|
8703
|
+
enabled: boolean;
|
|
8704
|
+
/**
|
|
8705
|
+
* @description Minutes after start or creation before the slot is released.
|
|
8706
|
+
* @enum {string}
|
|
8707
|
+
*/
|
|
8708
|
+
interval: "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
8623
8709
|
};
|
|
8624
|
-
/** @description
|
|
8625
|
-
|
|
8710
|
+
/** @description Avigilon Alta access group reference. */
|
|
8711
|
+
avigilonAltaGroupRef?: number | null;
|
|
8626
8712
|
/**
|
|
8627
|
-
*
|
|
8628
|
-
* @
|
|
8713
|
+
* @description Who can create bookings on this resource.
|
|
8714
|
+
* @enum {string}
|
|
8629
8715
|
*/
|
|
8630
|
-
|
|
8631
|
-
/** @description
|
|
8632
|
-
|
|
8633
|
-
|
|
8634
|
-
|
|
8716
|
+
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
8717
|
+
/** @description Booking step size in minutes. */
|
|
8718
|
+
bookingStepMinutes?: number;
|
|
8719
|
+
/** @description Brivo access group reference. */
|
|
8720
|
+
brivoGroupRef?: number | null;
|
|
8721
|
+
/**
|
|
8722
|
+
* @description Buffer time blocked before each booking.
|
|
8723
|
+
* @enum {string}
|
|
8724
|
+
*/
|
|
8725
|
+
bufferTime: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
8726
|
+
/** @description Maximum capacity per booking. */
|
|
8727
|
+
capacity?: number | null;
|
|
8728
|
+
/** @description Check-in settings. */
|
|
8729
|
+
checkIn?: {
|
|
8635
8730
|
/**
|
|
8636
|
-
*
|
|
8637
|
-
* @
|
|
8731
|
+
* @description How early before start the guest must check in.
|
|
8732
|
+
* @enum {string}
|
|
8638
8733
|
*/
|
|
8639
|
-
|
|
8640
|
-
/** @description ISO timestamp when the assignment starts. */
|
|
8641
|
-
startDate: string;
|
|
8734
|
+
interval: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
8642
8735
|
};
|
|
8643
|
-
/** @description
|
|
8644
|
-
|
|
8645
|
-
/** @description User email. */
|
|
8646
|
-
email?: string | null;
|
|
8736
|
+
/** @description Child resources when this is a parent resource. Bookings on a child resource also block the parent. */
|
|
8737
|
+
children: {
|
|
8647
8738
|
/**
|
|
8648
8739
|
* Format: uuid
|
|
8649
|
-
* @description
|
|
8740
|
+
* @description Id of the child resource.
|
|
8650
8741
|
*/
|
|
8651
8742
|
id: string;
|
|
8652
|
-
/** @description
|
|
8653
|
-
|
|
8654
|
-
|
|
8655
|
-
|
|
8743
|
+
/** @description Title of the child resource. */
|
|
8744
|
+
title: string;
|
|
8745
|
+
}[];
|
|
8746
|
+
/** @description Confirmation email settings. */
|
|
8747
|
+
confirmationEmail: {
|
|
8748
|
+
/** @description Send confirmation when an admin creates a booking. */
|
|
8749
|
+
bookingCreatedByAdmin: boolean;
|
|
8750
|
+
/** @description Send confirmation when a member creates a booking. */
|
|
8751
|
+
bookingCreatedByMember: boolean;
|
|
8752
|
+
/** @description Send confirmation when a network member creates a booking. */
|
|
8753
|
+
bookingCreatedByNetworkMember: boolean;
|
|
8754
|
+
/** @description Send confirmation when a public user creates a booking. */
|
|
8755
|
+
bookingCreatedByPublic: boolean;
|
|
8756
|
+
/** @description Email template id for confirmation emails. */
|
|
8757
|
+
template: string;
|
|
8656
8758
|
};
|
|
8657
|
-
}[];
|
|
8658
|
-
/** @description Auto-release settings for no-show bookings. */
|
|
8659
|
-
autoRelease?: {
|
|
8660
|
-
/** @description Whether auto-release is enabled. */
|
|
8661
|
-
enabled: boolean;
|
|
8662
8759
|
/**
|
|
8663
|
-
*
|
|
8664
|
-
* @
|
|
8665
|
-
*/
|
|
8666
|
-
interval: "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
8667
|
-
};
|
|
8668
|
-
/** @description Avigilon Alta access group reference. */
|
|
8669
|
-
avigilonAltaGroupRef?: number | null;
|
|
8670
|
-
/**
|
|
8671
|
-
* @description Who can create bookings on this resource.
|
|
8672
|
-
* @enum {string}
|
|
8673
|
-
*/
|
|
8674
|
-
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
8675
|
-
/** @description Booking step size in minutes. */
|
|
8676
|
-
bookingStepMinutes?: number;
|
|
8677
|
-
/** @description Brivo access group reference. */
|
|
8678
|
-
brivoGroupRef?: number | null;
|
|
8679
|
-
/** @description Maximum capacity per booking. */
|
|
8680
|
-
capacity?: number | null;
|
|
8681
|
-
/** @description Check-in settings. */
|
|
8682
|
-
checkIn?: {
|
|
8683
|
-
/**
|
|
8684
|
-
* @description How early before start the guest must check in.
|
|
8685
|
-
* @enum {string}
|
|
8760
|
+
* Format: date-time
|
|
8761
|
+
* @description ISO timestamp of when the resource was created.
|
|
8686
8762
|
*/
|
|
8687
|
-
|
|
8688
|
-
|
|
8689
|
-
|
|
8690
|
-
|
|
8763
|
+
createDate: string;
|
|
8764
|
+
/** @description Credit pricing settings. */
|
|
8765
|
+
credits: {
|
|
8766
|
+
/** @description Whether customers can pay with location credits. */
|
|
8767
|
+
enabled: boolean;
|
|
8768
|
+
/** @description Stepped credit pricing tiers. */
|
|
8769
|
+
tiers: {
|
|
8770
|
+
/** @description Fixed fee added for this tier. */
|
|
8771
|
+
flatAmount: number;
|
|
8772
|
+
/** @description Start of this price tier in booking minutes. */
|
|
8773
|
+
from: number;
|
|
8774
|
+
/** @description Variable price per unit within this tier. */
|
|
8775
|
+
unitAmount: number;
|
|
8776
|
+
}[];
|
|
8777
|
+
};
|
|
8778
|
+
/** @description Whether day passes are enabled. */
|
|
8779
|
+
dayPassesEnabled?: boolean;
|
|
8780
|
+
/** @description Description of the resource. */
|
|
8781
|
+
description: string;
|
|
8782
|
+
/** @description Booking duration bounds. */
|
|
8783
|
+
duration: {
|
|
8784
|
+
/** @description Maximum booking duration in minutes. */
|
|
8785
|
+
max: number;
|
|
8786
|
+
/** @description Minimum booking duration in minutes. */
|
|
8787
|
+
min: number;
|
|
8788
|
+
/** @description Duration limits for public bookers. */
|
|
8789
|
+
public: {
|
|
8790
|
+
/** @description Whether public bookers have separate duration limits. */
|
|
8791
|
+
enabled: boolean;
|
|
8792
|
+
/** @description Maximum booking duration in minutes for public bookers. */
|
|
8793
|
+
max: number;
|
|
8794
|
+
/** @description Minimum booking duration in minutes for public bookers. */
|
|
8795
|
+
min: number;
|
|
8796
|
+
};
|
|
8797
|
+
};
|
|
8798
|
+
/** @description Dynamic pricing settings. */
|
|
8799
|
+
dynamicPricing: {
|
|
8800
|
+
/** @description Maximum price increase percentage when demand is high. */
|
|
8801
|
+
deltaAbove: number;
|
|
8802
|
+
/** @description Maximum price decrease percentage when demand is low. */
|
|
8803
|
+
deltaBelow: number;
|
|
8804
|
+
/** @description Whether dynamic pricing is enabled. */
|
|
8805
|
+
enabled: boolean;
|
|
8806
|
+
};
|
|
8807
|
+
/** @description Google Calendar integration settings. */
|
|
8808
|
+
googleCalendar?: {
|
|
8809
|
+
/** @description Google Calendar id. */
|
|
8810
|
+
id: string;
|
|
8811
|
+
/** @description Whether two-way sync is enabled. */
|
|
8812
|
+
twoWaySyncEnabled: boolean;
|
|
8813
|
+
};
|
|
8691
8814
|
/**
|
|
8692
8815
|
* Format: uuid
|
|
8693
|
-
* @description
|
|
8816
|
+
* @description Unique identifier of the resource.
|
|
8694
8817
|
*/
|
|
8695
8818
|
id: string;
|
|
8696
|
-
/** @description
|
|
8697
|
-
|
|
8698
|
-
|
|
8699
|
-
|
|
8700
|
-
|
|
8701
|
-
|
|
8702
|
-
|
|
8703
|
-
|
|
8704
|
-
|
|
8705
|
-
|
|
8706
|
-
|
|
8707
|
-
/** @description
|
|
8708
|
-
|
|
8709
|
-
|
|
8710
|
-
|
|
8711
|
-
|
|
8712
|
-
|
|
8713
|
-
* Format: date-time
|
|
8714
|
-
* @description ISO timestamp of when the resource was created.
|
|
8715
|
-
*/
|
|
8716
|
-
createDate: string;
|
|
8717
|
-
/** @description Credit pricing settings. */
|
|
8718
|
-
credits: {
|
|
8719
|
-
/** @description Whether customers can pay with location credits. */
|
|
8720
|
-
enabled: boolean;
|
|
8721
|
-
/** @description Stepped credit pricing tiers. */
|
|
8722
|
-
tiers: {
|
|
8723
|
-
/** @description Fixed fee added for this tier. */
|
|
8724
|
-
flatAmount: number;
|
|
8725
|
-
/** @description Start of this price tier in booking minutes. */
|
|
8726
|
-
from: number;
|
|
8727
|
-
/** @description Variable price per unit within this tier. */
|
|
8728
|
-
unitAmount: number;
|
|
8819
|
+
/** @description Public URL of the resource image. */
|
|
8820
|
+
imageUrl?: string;
|
|
8821
|
+
/** @description Kisi access group reference. */
|
|
8822
|
+
kisiGroupRef?: number | null;
|
|
8823
|
+
/** @description Auto-detected language of the description. */
|
|
8824
|
+
locale: string;
|
|
8825
|
+
/**
|
|
8826
|
+
* Format: uuid
|
|
8827
|
+
* @description ID of the location.
|
|
8828
|
+
*/
|
|
8829
|
+
locationRef: string;
|
|
8830
|
+
/** @description Images attached to the resource. */
|
|
8831
|
+
media: {
|
|
8832
|
+
/** @description Storage key of the image. */
|
|
8833
|
+
key: string;
|
|
8834
|
+
/** @description Public URL of the image. */
|
|
8835
|
+
url?: string;
|
|
8729
8836
|
}[];
|
|
8730
|
-
|
|
8731
|
-
|
|
8732
|
-
|
|
8733
|
-
/** @description Description of the resource. */
|
|
8734
|
-
description: string;
|
|
8735
|
-
/** @description Booking duration bounds. */
|
|
8736
|
-
duration: {
|
|
8737
|
-
/** @description Maximum booking duration in minutes. */
|
|
8738
|
-
max: number;
|
|
8739
|
-
/** @description Minimum booking duration in minutes. */
|
|
8740
|
-
min: number;
|
|
8741
|
-
/** @description Duration limits for public bookers. */
|
|
8742
|
-
public: {
|
|
8743
|
-
/** @description Whether public bookers have separate duration limits. */
|
|
8837
|
+
/** @description Money pricing settings. */
|
|
8838
|
+
money: {
|
|
8839
|
+
/** @description Whether customers can pay with money. */
|
|
8744
8840
|
enabled: boolean;
|
|
8745
|
-
/** @description
|
|
8746
|
-
|
|
8747
|
-
|
|
8748
|
-
|
|
8841
|
+
/** @description Stepped money pricing tiers. */
|
|
8842
|
+
tiers: {
|
|
8843
|
+
/** @description Fixed fee added for this tier. */
|
|
8844
|
+
flatAmount: number;
|
|
8845
|
+
/** @description Start of this price tier in booking minutes. */
|
|
8846
|
+
from: number;
|
|
8847
|
+
/** @description Variable price per unit within this tier. */
|
|
8848
|
+
unitAmount: number;
|
|
8849
|
+
}[];
|
|
8749
8850
|
};
|
|
8750
|
-
|
|
8751
|
-
|
|
8752
|
-
|
|
8753
|
-
|
|
8754
|
-
|
|
8755
|
-
/**
|
|
8756
|
-
|
|
8757
|
-
|
|
8758
|
-
|
|
8759
|
-
|
|
8760
|
-
/** @description Google Calendar integration settings. */
|
|
8761
|
-
googleCalendar?: {
|
|
8762
|
-
/** @description Google Calendar id. */
|
|
8763
|
-
id: string;
|
|
8764
|
-
/** @description Whether two-way sync is enabled. */
|
|
8765
|
-
twoWaySyncEnabled: boolean;
|
|
8766
|
-
};
|
|
8767
|
-
/**
|
|
8768
|
-
* Format: uuid
|
|
8769
|
-
* @description Unique identifier of the resource.
|
|
8770
|
-
*/
|
|
8771
|
-
id: string;
|
|
8772
|
-
/** @description Public URL of the resource image. */
|
|
8773
|
-
imageUrl?: string;
|
|
8774
|
-
/** @description Kisi access group reference. */
|
|
8775
|
-
kisiGroupRef?: number | null;
|
|
8776
|
-
/** @description Auto-detected language of the description. */
|
|
8777
|
-
locale: string;
|
|
8778
|
-
/**
|
|
8779
|
-
* Format: uuid
|
|
8780
|
-
* @description ID of the location.
|
|
8781
|
-
*/
|
|
8782
|
-
locationRef: string;
|
|
8783
|
-
/** @description Images attached to the resource. */
|
|
8784
|
-
media: {
|
|
8785
|
-
/** @description Storage key of the image. */
|
|
8786
|
-
key: string;
|
|
8787
|
-
/** @description Public URL of the image. */
|
|
8788
|
-
url?: string;
|
|
8789
|
-
}[];
|
|
8790
|
-
/** @description Money pricing settings. */
|
|
8791
|
-
money: {
|
|
8792
|
-
/** @description Whether customers can pay with money. */
|
|
8793
|
-
enabled: boolean;
|
|
8794
|
-
/** @description Stepped money pricing tiers. */
|
|
8795
|
-
tiers: {
|
|
8796
|
-
/** @description Fixed fee added for this tier. */
|
|
8797
|
-
flatAmount: number;
|
|
8798
|
-
/** @description Start of this price tier in booking minutes. */
|
|
8799
|
-
from: number;
|
|
8800
|
-
/** @description Variable price per unit within this tier. */
|
|
8801
|
-
unitAmount: number;
|
|
8802
|
-
}[];
|
|
8803
|
-
};
|
|
8804
|
-
/**
|
|
8805
|
-
* Format: uuid
|
|
8806
|
-
* @description ID of the network.
|
|
8807
|
-
*/
|
|
8808
|
-
networkRef: string;
|
|
8809
|
-
/**
|
|
8810
|
-
* Format: uuid
|
|
8811
|
-
* @description Parent resource id when this is a child resource.
|
|
8812
|
-
*/
|
|
8813
|
-
parentRef?: string;
|
|
8814
|
-
/** @description Plan tiers configured on the resource. */
|
|
8815
|
-
plans?: {
|
|
8816
|
-
/** @description Whether plan-based access is enabled. */
|
|
8817
|
-
enabled: boolean;
|
|
8851
|
+
/**
|
|
8852
|
+
* Format: uuid
|
|
8853
|
+
* @description ID of the network.
|
|
8854
|
+
*/
|
|
8855
|
+
networkRef: string;
|
|
8856
|
+
/**
|
|
8857
|
+
* Format: uuid
|
|
8858
|
+
* @description Parent resource id when this is a child resource.
|
|
8859
|
+
*/
|
|
8860
|
+
parentRef?: string;
|
|
8818
8861
|
/** @description Plan tiers configured on the resource. */
|
|
8819
|
-
|
|
8820
|
-
/** @description
|
|
8821
|
-
|
|
8822
|
-
|
|
8823
|
-
|
|
8824
|
-
|
|
8825
|
-
|
|
8826
|
-
id: string;
|
|
8827
|
-
}[];
|
|
8828
|
-
/** @description Number of billing cycles in the tier. */
|
|
8829
|
-
commitmentCycles: number;
|
|
8830
|
-
/** @description Credits included in the tier. */
|
|
8831
|
-
credits: number;
|
|
8832
|
-
/** @description Day passes included in the tier. */
|
|
8833
|
-
dayPasses?: number;
|
|
8834
|
-
/** @description Description of the tier. */
|
|
8835
|
-
description?: string;
|
|
8836
|
-
/**
|
|
8837
|
-
* @deprecated
|
|
8838
|
-
* @description Synthetic discount percentages by product type.
|
|
8839
|
-
*/
|
|
8840
|
-
discounts?: {
|
|
8841
|
-
/** @description Discount percentage for credit packages. */
|
|
8842
|
-
creditPackages?: number;
|
|
8843
|
-
/** @description Discount percentage for desk bookings. */
|
|
8844
|
-
desks?: number;
|
|
8845
|
-
/** @description Discount percentage for equipment bookings. */
|
|
8846
|
-
equipment?: number;
|
|
8847
|
-
/** @description Discount percentage for events. */
|
|
8848
|
-
events?: number;
|
|
8849
|
-
/** @description Discount percentage for room bookings. */
|
|
8850
|
-
rooms?: number;
|
|
8851
|
-
/** @description Discount percentage for shop products. */
|
|
8852
|
-
shop?: number;
|
|
8853
|
-
};
|
|
8854
|
-
/** @description Whether the tier grants access to the entire resource. */
|
|
8855
|
-
entire: boolean;
|
|
8856
|
-
/** @description Coupons granted to members on this tier. */
|
|
8857
|
-
grantedDiscounts: {
|
|
8858
|
-
/** @description Granted coupon details. */
|
|
8859
|
-
coupon: {
|
|
8860
|
-
/** @description Fixed discount amount. */
|
|
8861
|
-
amountOff?: number;
|
|
8862
|
-
/** @description Currency code for amountOff. */
|
|
8863
|
-
currencyCode?: string;
|
|
8864
|
-
/** @description Whether the coupon applies to credit purchases. */
|
|
8865
|
-
enabledForCredits?: boolean;
|
|
8862
|
+
plans?: {
|
|
8863
|
+
/** @description Whether plan-based access is enabled. */
|
|
8864
|
+
enabled: boolean;
|
|
8865
|
+
/** @description Plan tiers configured on the resource. */
|
|
8866
|
+
tiers: {
|
|
8867
|
+
/** @description Addons included in the tier. */
|
|
8868
|
+
addons: {
|
|
8866
8869
|
/**
|
|
8867
8870
|
* Format: uuid
|
|
8868
|
-
* @description
|
|
8871
|
+
* @description Addon id.
|
|
8869
8872
|
*/
|
|
8870
8873
|
id: string;
|
|
8871
|
-
|
|
8872
|
-
limitedItems?: {
|
|
8873
|
-
/** @description Whether item-level limits are enabled. */
|
|
8874
|
-
enabled: boolean;
|
|
8875
|
-
/** @description Items the coupon applies to when limits are enabled. */
|
|
8876
|
-
values: {
|
|
8877
|
-
/**
|
|
8878
|
-
* Format: uuid
|
|
8879
|
-
* @description Unique identifier of the limited item.
|
|
8880
|
-
*/
|
|
8881
|
-
id: string;
|
|
8882
|
-
/** @description Display name of the limited item. */
|
|
8883
|
-
title?: string;
|
|
8884
|
-
/**
|
|
8885
|
-
* @description Product type of the limited item.
|
|
8886
|
-
* @enum {string}
|
|
8887
|
-
*/
|
|
8888
|
-
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
8889
|
-
}[];
|
|
8890
|
-
};
|
|
8891
|
-
/** @description Redemption limits for the coupon. */
|
|
8892
|
-
limitedRedemption?: {
|
|
8893
|
-
/** @description Whether redemption limits are enabled. */
|
|
8894
|
-
enabled: boolean;
|
|
8895
|
-
/** @description Current redemption count. */
|
|
8896
|
-
usage: number;
|
|
8897
|
-
/** @description Maximum redemption count. */
|
|
8898
|
-
value: number;
|
|
8899
|
-
};
|
|
8900
|
-
/** @description Percentage discount. */
|
|
8901
|
-
percentOff?: number;
|
|
8902
|
-
/** @description Product types the coupon applies to. */
|
|
8903
|
-
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
8904
|
-
};
|
|
8905
|
-
}[];
|
|
8906
|
-
/**
|
|
8907
|
-
* Format: uuid
|
|
8908
|
-
* @description Unique identifier of the tier.
|
|
8909
|
-
*/
|
|
8910
|
-
id: string;
|
|
8911
|
-
/**
|
|
8912
|
-
* @description Billing period of the tier.
|
|
8913
|
-
* @enum {string}
|
|
8914
|
-
*/
|
|
8915
|
-
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
8916
|
-
/** @description Nested plan details on responses. */
|
|
8917
|
-
plan: {
|
|
8874
|
+
}[];
|
|
8918
8875
|
/** @description Number of billing cycles in the tier. */
|
|
8919
8876
|
commitmentCycles: number;
|
|
8920
8877
|
/** @description Credits included in the tier. */
|
|
8921
8878
|
credits: number;
|
|
8922
8879
|
/** @description Day passes included in the tier. */
|
|
8923
|
-
dayPasses
|
|
8880
|
+
dayPasses?: number;
|
|
8881
|
+
/** @description Description of the tier. */
|
|
8882
|
+
description?: string;
|
|
8924
8883
|
/**
|
|
8925
8884
|
* @deprecated
|
|
8926
8885
|
* @description Synthetic discount percentages by product type.
|
|
@@ -8939,6 +8898,8 @@ interface components {
|
|
|
8939
8898
|
/** @description Discount percentage for shop products. */
|
|
8940
8899
|
shop?: number;
|
|
8941
8900
|
};
|
|
8901
|
+
/** @description Whether the tier grants access to the entire resource. */
|
|
8902
|
+
entire: boolean;
|
|
8942
8903
|
/** @description Coupons granted to members on this tier. */
|
|
8943
8904
|
grantedDiscounts: {
|
|
8944
8905
|
/** @description Granted coupon details. */
|
|
@@ -8999,244 +8960,1291 @@ interface components {
|
|
|
8999
8960
|
* @enum {string}
|
|
9000
8961
|
*/
|
|
9001
8962
|
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
8963
|
+
/** @description Nested plan details on responses. */
|
|
8964
|
+
plan: {
|
|
8965
|
+
/** @description Number of billing cycles in the tier. */
|
|
8966
|
+
commitmentCycles: number;
|
|
8967
|
+
/** @description Credits included in the tier. */
|
|
8968
|
+
credits: number;
|
|
8969
|
+
/** @description Day passes included in the tier. */
|
|
8970
|
+
dayPasses: number;
|
|
8971
|
+
/**
|
|
8972
|
+
* @deprecated
|
|
8973
|
+
* @description Synthetic discount percentages by product type.
|
|
8974
|
+
*/
|
|
8975
|
+
discounts?: {
|
|
8976
|
+
/** @description Discount percentage for credit packages. */
|
|
8977
|
+
creditPackages?: number;
|
|
8978
|
+
/** @description Discount percentage for desk bookings. */
|
|
8979
|
+
desks?: number;
|
|
8980
|
+
/** @description Discount percentage for equipment bookings. */
|
|
8981
|
+
equipment?: number;
|
|
8982
|
+
/** @description Discount percentage for events. */
|
|
8983
|
+
events?: number;
|
|
8984
|
+
/** @description Discount percentage for room bookings. */
|
|
8985
|
+
rooms?: number;
|
|
8986
|
+
/** @description Discount percentage for shop products. */
|
|
8987
|
+
shop?: number;
|
|
8988
|
+
};
|
|
8989
|
+
/** @description Coupons granted to members on this tier. */
|
|
8990
|
+
grantedDiscounts: {
|
|
8991
|
+
/** @description Granted coupon details. */
|
|
8992
|
+
coupon: {
|
|
8993
|
+
/** @description Fixed discount amount. */
|
|
8994
|
+
amountOff?: number;
|
|
8995
|
+
/** @description Currency code for amountOff. */
|
|
8996
|
+
currencyCode?: string;
|
|
8997
|
+
/** @description Whether the coupon applies to credit purchases. */
|
|
8998
|
+
enabledForCredits?: boolean;
|
|
8999
|
+
/**
|
|
9000
|
+
* Format: uuid
|
|
9001
|
+
* @description Unique identifier of the coupon.
|
|
9002
|
+
*/
|
|
9003
|
+
id: string;
|
|
9004
|
+
/** @description Item-level redemption limits. */
|
|
9005
|
+
limitedItems?: {
|
|
9006
|
+
/** @description Whether item-level limits are enabled. */
|
|
9007
|
+
enabled: boolean;
|
|
9008
|
+
/** @description Items the coupon applies to when limits are enabled. */
|
|
9009
|
+
values: {
|
|
9010
|
+
/**
|
|
9011
|
+
* Format: uuid
|
|
9012
|
+
* @description Unique identifier of the limited item.
|
|
9013
|
+
*/
|
|
9014
|
+
id: string;
|
|
9015
|
+
/** @description Display name of the limited item. */
|
|
9016
|
+
title?: string;
|
|
9017
|
+
/**
|
|
9018
|
+
* @description Product type of the limited item.
|
|
9019
|
+
* @enum {string}
|
|
9020
|
+
*/
|
|
9021
|
+
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
9022
|
+
}[];
|
|
9023
|
+
};
|
|
9024
|
+
/** @description Redemption limits for the coupon. */
|
|
9025
|
+
limitedRedemption?: {
|
|
9026
|
+
/** @description Whether redemption limits are enabled. */
|
|
9027
|
+
enabled: boolean;
|
|
9028
|
+
/** @description Current redemption count. */
|
|
9029
|
+
usage: number;
|
|
9030
|
+
/** @description Maximum redemption count. */
|
|
9031
|
+
value: number;
|
|
9032
|
+
};
|
|
9033
|
+
/** @description Percentage discount. */
|
|
9034
|
+
percentOff?: number;
|
|
9035
|
+
/** @description Product types the coupon applies to. */
|
|
9036
|
+
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
9037
|
+
};
|
|
9038
|
+
}[];
|
|
9039
|
+
/**
|
|
9040
|
+
* Format: uuid
|
|
9041
|
+
* @description Unique identifier of the tier.
|
|
9042
|
+
*/
|
|
9043
|
+
id: string;
|
|
9044
|
+
/**
|
|
9045
|
+
* @description Billing period of the tier.
|
|
9046
|
+
* @enum {string}
|
|
9047
|
+
*/
|
|
9048
|
+
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
9049
|
+
/** @description Price of the tier. */
|
|
9050
|
+
price: number;
|
|
9051
|
+
/** @description Title of the tier. */
|
|
9052
|
+
title: string;
|
|
9053
|
+
};
|
|
9002
9054
|
/** @description Price of the tier. */
|
|
9003
9055
|
price: number;
|
|
9056
|
+
/** @description Self sign-up settings of the tier. */
|
|
9057
|
+
selfSignup: {
|
|
9058
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
9059
|
+
enabled: boolean;
|
|
9060
|
+
/** @description Self sign-up flow type for the tier. */
|
|
9061
|
+
type: string;
|
|
9062
|
+
};
|
|
9063
|
+
/**
|
|
9064
|
+
* @deprecated
|
|
9065
|
+
* @description Deprecated. Use selfSignup.type instead. Self sign-up flow type for the tier.
|
|
9066
|
+
*/
|
|
9067
|
+
selfSignupType?: string;
|
|
9068
|
+
/** @description One-time setup fee for the tier. */
|
|
9069
|
+
setupFee: number;
|
|
9004
9070
|
/** @description Title of the tier. */
|
|
9005
9071
|
title: string;
|
|
9072
|
+
}[];
|
|
9073
|
+
};
|
|
9074
|
+
/**
|
|
9075
|
+
* @deprecated
|
|
9076
|
+
* @description Deprecated. Use bufferTime instead.
|
|
9077
|
+
* @enum {string}
|
|
9078
|
+
*/
|
|
9079
|
+
preparationMinutes: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
9080
|
+
/**
|
|
9081
|
+
* @description Refund threshold for cancellations.
|
|
9082
|
+
* @enum {string}
|
|
9083
|
+
*/
|
|
9084
|
+
refundThreshold: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
9085
|
+
/**
|
|
9086
|
+
* Format: uuid
|
|
9087
|
+
* @description Salto KS access group reference.
|
|
9088
|
+
*/
|
|
9089
|
+
saltoksAccessGroupRef?: string | null;
|
|
9090
|
+
/** @description Availability schedule. */
|
|
9091
|
+
schedule?: {
|
|
9092
|
+
/** @description Default availability schedule. */
|
|
9093
|
+
default: {
|
|
9094
|
+
/** @description Dates in MM-DD format when the resource is closed. */
|
|
9095
|
+
closedDays: string[];
|
|
9096
|
+
/** @description Weekly availability windows for members. */
|
|
9097
|
+
items: {
|
|
9098
|
+
/** @description Weekdays this time window applies to. */
|
|
9099
|
+
days: {
|
|
9100
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9101
|
+
friday: boolean;
|
|
9102
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9103
|
+
monday: boolean;
|
|
9104
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9105
|
+
saturday: boolean;
|
|
9106
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9107
|
+
sunday: boolean;
|
|
9108
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9109
|
+
thursday: boolean;
|
|
9110
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9111
|
+
tuesday: boolean;
|
|
9112
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9113
|
+
wednesday: boolean;
|
|
9114
|
+
};
|
|
9115
|
+
/** @description Open hours for the selected weekdays. */
|
|
9116
|
+
hours: {
|
|
9117
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9118
|
+
from: string;
|
|
9119
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9120
|
+
to: string;
|
|
9121
|
+
};
|
|
9122
|
+
}[];
|
|
9006
9123
|
};
|
|
9007
|
-
/** @description
|
|
9008
|
-
|
|
9009
|
-
/** @description
|
|
9010
|
-
|
|
9011
|
-
/** @description
|
|
9124
|
+
/** @description Whether scheduling is enabled. */
|
|
9125
|
+
enabled: boolean;
|
|
9126
|
+
/** @description Public availability schedule. */
|
|
9127
|
+
public: {
|
|
9128
|
+
/** @description Dates in MM-DD format when the resource is closed for public bookers. */
|
|
9129
|
+
closedDays: string[];
|
|
9130
|
+
/** @description Whether the public schedule is enabled. */
|
|
9012
9131
|
enabled: boolean;
|
|
9013
|
-
/** @description
|
|
9014
|
-
|
|
9132
|
+
/** @description Weekly availability windows for public bookers. */
|
|
9133
|
+
items: {
|
|
9134
|
+
/** @description Weekdays this time window applies to. */
|
|
9135
|
+
days: {
|
|
9136
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9137
|
+
friday: boolean;
|
|
9138
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9139
|
+
monday: boolean;
|
|
9140
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9141
|
+
saturday: boolean;
|
|
9142
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9143
|
+
sunday: boolean;
|
|
9144
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9145
|
+
thursday: boolean;
|
|
9146
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9147
|
+
tuesday: boolean;
|
|
9148
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9149
|
+
wednesday: boolean;
|
|
9150
|
+
};
|
|
9151
|
+
/** @description Open hours for the selected weekdays. */
|
|
9152
|
+
hours: {
|
|
9153
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9154
|
+
from: string;
|
|
9155
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9156
|
+
to: string;
|
|
9157
|
+
};
|
|
9158
|
+
}[];
|
|
9015
9159
|
};
|
|
9160
|
+
};
|
|
9161
|
+
/**
|
|
9162
|
+
* Format: uuid
|
|
9163
|
+
* @description Tapkey access group reference.
|
|
9164
|
+
*/
|
|
9165
|
+
tapkeyGroupRef?: string | null;
|
|
9166
|
+
/** @description Display name of the resource. */
|
|
9167
|
+
title: string;
|
|
9168
|
+
/**
|
|
9169
|
+
* @description Type of the resource.
|
|
9170
|
+
* @enum {string}
|
|
9171
|
+
*/
|
|
9172
|
+
type: "dedicatedDesk" | "equipment" | "hotDesk" | "office" | "parkingLot" | "room" | "station" | "conferenceRoom" | "eventSpace" | "meetingRoom" | "phoneBooth" | "studio";
|
|
9173
|
+
/**
|
|
9174
|
+
* @description Visibility of the resource.
|
|
9175
|
+
* @enum {string}
|
|
9176
|
+
*/
|
|
9177
|
+
visibility: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9178
|
+
}[];
|
|
9179
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
9180
|
+
searchQueryNext?: string;
|
|
9181
|
+
};
|
|
9182
|
+
getResource: {
|
|
9183
|
+
/** @description The resource. */
|
|
9184
|
+
resource: {
|
|
9185
|
+
/** @description Active resource assignments. */
|
|
9186
|
+
assignments: {
|
|
9016
9187
|
/**
|
|
9017
9188
|
* @deprecated
|
|
9018
|
-
* @description Deprecated. Use
|
|
9189
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
9019
9190
|
*/
|
|
9020
|
-
|
|
9021
|
-
|
|
9022
|
-
|
|
9023
|
-
|
|
9024
|
-
|
|
9025
|
-
|
|
9026
|
-
|
|
9027
|
-
|
|
9028
|
-
|
|
9029
|
-
|
|
9030
|
-
|
|
9031
|
-
|
|
9032
|
-
|
|
9033
|
-
|
|
9034
|
-
|
|
9035
|
-
|
|
9036
|
-
|
|
9037
|
-
|
|
9038
|
-
|
|
9039
|
-
|
|
9040
|
-
|
|
9041
|
-
|
|
9042
|
-
|
|
9043
|
-
|
|
9044
|
-
|
|
9045
|
-
|
|
9046
|
-
|
|
9047
|
-
|
|
9048
|
-
|
|
9049
|
-
|
|
9050
|
-
|
|
9051
|
-
|
|
9052
|
-
/** @description
|
|
9053
|
-
|
|
9054
|
-
/** @description
|
|
9055
|
-
|
|
9056
|
-
/** @description Whether Saturday is included in this schedule window. */
|
|
9057
|
-
saturday: boolean;
|
|
9058
|
-
/** @description Whether Sunday is included in this schedule window. */
|
|
9059
|
-
sunday: boolean;
|
|
9060
|
-
/** @description Whether Thursday is included in this schedule window. */
|
|
9061
|
-
thursday: boolean;
|
|
9062
|
-
/** @description Whether Tuesday is included in this schedule window. */
|
|
9063
|
-
tuesday: boolean;
|
|
9064
|
-
/** @description Whether Wednesday is included in this schedule window. */
|
|
9065
|
-
wednesday: boolean;
|
|
9066
|
-
};
|
|
9067
|
-
/** @description Open hours for the selected weekdays. */
|
|
9068
|
-
hours: {
|
|
9069
|
-
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9070
|
-
from: string;
|
|
9071
|
-
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9072
|
-
to: string;
|
|
9191
|
+
company?: {
|
|
9192
|
+
/**
|
|
9193
|
+
* Format: uuid
|
|
9194
|
+
* @description Company id.
|
|
9195
|
+
*/
|
|
9196
|
+
id: string;
|
|
9197
|
+
/** @description Company name. */
|
|
9198
|
+
title: string;
|
|
9199
|
+
};
|
|
9200
|
+
/** @description Customer the resource is assigned to. */
|
|
9201
|
+
customer?: {
|
|
9202
|
+
/**
|
|
9203
|
+
* Format: uuid
|
|
9204
|
+
* @description Customer id.
|
|
9205
|
+
*/
|
|
9206
|
+
id: string;
|
|
9207
|
+
/** @description Company name when the customer is a company. */
|
|
9208
|
+
title?: string;
|
|
9209
|
+
/**
|
|
9210
|
+
* @description Whether the customer is a user or company.
|
|
9211
|
+
* @enum {string}
|
|
9212
|
+
*/
|
|
9213
|
+
type: "user" | "company";
|
|
9214
|
+
/** @description User details when the customer is a user. */
|
|
9215
|
+
user?: {
|
|
9216
|
+
/** @description User email. */
|
|
9217
|
+
email?: string | null;
|
|
9218
|
+
/**
|
|
9219
|
+
* Format: uuid
|
|
9220
|
+
* @description User id.
|
|
9221
|
+
*/
|
|
9222
|
+
id: string;
|
|
9223
|
+
/** @description User first name. */
|
|
9224
|
+
name?: string | null;
|
|
9225
|
+
/** @description User last name. */
|
|
9226
|
+
surname?: string | null;
|
|
9073
9227
|
};
|
|
9074
|
-
}
|
|
9075
|
-
|
|
9076
|
-
|
|
9077
|
-
|
|
9078
|
-
|
|
9079
|
-
|
|
9080
|
-
|
|
9081
|
-
|
|
9082
|
-
/**
|
|
9228
|
+
};
|
|
9229
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
9230
|
+
entire: boolean;
|
|
9231
|
+
/**
|
|
9232
|
+
* Format: uuid
|
|
9233
|
+
* @description Assignment id.
|
|
9234
|
+
*/
|
|
9235
|
+
id?: string;
|
|
9236
|
+
/**
|
|
9237
|
+
* @deprecated
|
|
9238
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
9239
|
+
*/
|
|
9240
|
+
membership?: {
|
|
9241
|
+
/**
|
|
9242
|
+
* Format: uuid
|
|
9243
|
+
* @description Membership id.
|
|
9244
|
+
*/
|
|
9245
|
+
id: string;
|
|
9246
|
+
};
|
|
9247
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9248
|
+
quantity?: number;
|
|
9249
|
+
/**
|
|
9250
|
+
* Format: uuid
|
|
9251
|
+
* @description UUID of the resource the assignment belongs to.
|
|
9252
|
+
*/
|
|
9253
|
+
resourceRef: string;
|
|
9254
|
+
/** @description Subscription backing this assignment. */
|
|
9255
|
+
subscription: {
|
|
9256
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
9257
|
+
endDate?: string;
|
|
9258
|
+
/**
|
|
9259
|
+
* Format: uuid
|
|
9260
|
+
* @description Subscription id.
|
|
9261
|
+
*/
|
|
9262
|
+
id: string;
|
|
9263
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
9264
|
+
startDate: string;
|
|
9265
|
+
};
|
|
9266
|
+
/**
|
|
9267
|
+
* @deprecated
|
|
9268
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
9269
|
+
*/
|
|
9270
|
+
user?: {
|
|
9271
|
+
/** @description User email. */
|
|
9272
|
+
email?: string | null;
|
|
9273
|
+
/**
|
|
9274
|
+
* Format: uuid
|
|
9275
|
+
* @description User id.
|
|
9276
|
+
*/
|
|
9277
|
+
id: string;
|
|
9278
|
+
/** @description User first name. */
|
|
9279
|
+
name?: string | null;
|
|
9280
|
+
/** @description User last name. */
|
|
9281
|
+
surname?: string | null;
|
|
9282
|
+
};
|
|
9283
|
+
}[];
|
|
9284
|
+
/** @description Auto-release settings for no-show bookings. */
|
|
9285
|
+
autoRelease?: {
|
|
9286
|
+
/** @description Whether auto-release is enabled. */
|
|
9083
9287
|
enabled: boolean;
|
|
9084
|
-
/**
|
|
9085
|
-
|
|
9086
|
-
|
|
9087
|
-
|
|
9088
|
-
|
|
9089
|
-
friday: boolean;
|
|
9090
|
-
/** @description Whether Monday is included in this schedule window. */
|
|
9091
|
-
monday: boolean;
|
|
9092
|
-
/** @description Whether Saturday is included in this schedule window. */
|
|
9093
|
-
saturday: boolean;
|
|
9094
|
-
/** @description Whether Sunday is included in this schedule window. */
|
|
9095
|
-
sunday: boolean;
|
|
9096
|
-
/** @description Whether Thursday is included in this schedule window. */
|
|
9097
|
-
thursday: boolean;
|
|
9098
|
-
/** @description Whether Tuesday is included in this schedule window. */
|
|
9099
|
-
tuesday: boolean;
|
|
9100
|
-
/** @description Whether Wednesday is included in this schedule window. */
|
|
9101
|
-
wednesday: boolean;
|
|
9102
|
-
};
|
|
9103
|
-
/** @description Open hours for the selected weekdays. */
|
|
9104
|
-
hours: {
|
|
9105
|
-
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9106
|
-
from: string;
|
|
9107
|
-
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9108
|
-
to: string;
|
|
9109
|
-
};
|
|
9110
|
-
}[];
|
|
9288
|
+
/**
|
|
9289
|
+
* @description Minutes after start or creation before the slot is released.
|
|
9290
|
+
* @enum {string}
|
|
9291
|
+
*/
|
|
9292
|
+
interval: "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
9111
9293
|
};
|
|
9112
|
-
|
|
9113
|
-
|
|
9114
|
-
|
|
9115
|
-
|
|
9116
|
-
|
|
9117
|
-
|
|
9118
|
-
|
|
9119
|
-
|
|
9120
|
-
|
|
9121
|
-
|
|
9122
|
-
|
|
9123
|
-
|
|
9124
|
-
|
|
9125
|
-
|
|
9126
|
-
|
|
9127
|
-
|
|
9128
|
-
|
|
9129
|
-
|
|
9130
|
-
|
|
9131
|
-
|
|
9132
|
-
|
|
9133
|
-
|
|
9134
|
-
|
|
9135
|
-
|
|
9294
|
+
/** @description Avigilon Alta access group reference. */
|
|
9295
|
+
avigilonAltaGroupRef?: number | null;
|
|
9296
|
+
/**
|
|
9297
|
+
* @description Who can create bookings on this resource.
|
|
9298
|
+
* @enum {string}
|
|
9299
|
+
*/
|
|
9300
|
+
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9301
|
+
/** @description Booking step size in minutes. */
|
|
9302
|
+
bookingStepMinutes?: number;
|
|
9303
|
+
/** @description Brivo access group reference. */
|
|
9304
|
+
brivoGroupRef?: number | null;
|
|
9305
|
+
/**
|
|
9306
|
+
* @description Buffer time blocked before each booking.
|
|
9307
|
+
* @enum {string}
|
|
9308
|
+
*/
|
|
9309
|
+
bufferTime: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
9310
|
+
/** @description Maximum capacity per booking. */
|
|
9311
|
+
capacity?: number | null;
|
|
9312
|
+
/** @description Check-in settings. */
|
|
9313
|
+
checkIn?: {
|
|
9314
|
+
/**
|
|
9315
|
+
* @description How early before start the guest must check in.
|
|
9316
|
+
* @enum {string}
|
|
9317
|
+
*/
|
|
9318
|
+
interval: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
9319
|
+
};
|
|
9320
|
+
/** @description Child resources when this is a parent resource. Bookings on a child resource also block the parent. */
|
|
9321
|
+
children: {
|
|
9136
9322
|
/**
|
|
9137
9323
|
* Format: uuid
|
|
9138
|
-
* @description
|
|
9324
|
+
* @description Id of the child resource.
|
|
9139
9325
|
*/
|
|
9140
9326
|
id: string;
|
|
9141
|
-
/** @description
|
|
9327
|
+
/** @description Title of the child resource. */
|
|
9142
9328
|
title: string;
|
|
9329
|
+
}[];
|
|
9330
|
+
/** @description Confirmation email settings. */
|
|
9331
|
+
confirmationEmail: {
|
|
9332
|
+
/** @description Send confirmation when an admin creates a booking. */
|
|
9333
|
+
bookingCreatedByAdmin: boolean;
|
|
9334
|
+
/** @description Send confirmation when a member creates a booking. */
|
|
9335
|
+
bookingCreatedByMember: boolean;
|
|
9336
|
+
/** @description Send confirmation when a network member creates a booking. */
|
|
9337
|
+
bookingCreatedByNetworkMember: boolean;
|
|
9338
|
+
/** @description Send confirmation when a public user creates a booking. */
|
|
9339
|
+
bookingCreatedByPublic: boolean;
|
|
9340
|
+
/** @description Email template id for confirmation emails. */
|
|
9341
|
+
template: string;
|
|
9143
9342
|
};
|
|
9144
|
-
/**
|
|
9145
|
-
|
|
9343
|
+
/**
|
|
9344
|
+
* Format: date-time
|
|
9345
|
+
* @description ISO timestamp of when the resource was created.
|
|
9346
|
+
*/
|
|
9347
|
+
createDate: string;
|
|
9348
|
+
/** @description Credit pricing settings. */
|
|
9349
|
+
credits: {
|
|
9350
|
+
/** @description Whether customers can pay with location credits. */
|
|
9351
|
+
enabled: boolean;
|
|
9352
|
+
/** @description Stepped credit pricing tiers. */
|
|
9353
|
+
tiers: {
|
|
9354
|
+
/** @description Fixed fee added for this tier. */
|
|
9355
|
+
flatAmount: number;
|
|
9356
|
+
/** @description Start of this price tier in booking minutes. */
|
|
9357
|
+
from: number;
|
|
9358
|
+
/** @description Variable price per unit within this tier. */
|
|
9359
|
+
unitAmount: number;
|
|
9360
|
+
}[];
|
|
9361
|
+
};
|
|
9362
|
+
/** @description Whether day passes are enabled. */
|
|
9363
|
+
dayPassesEnabled?: boolean;
|
|
9364
|
+
/** @description Description of the resource. */
|
|
9365
|
+
description: string;
|
|
9366
|
+
/** @description Booking duration bounds. */
|
|
9367
|
+
duration: {
|
|
9368
|
+
/** @description Maximum booking duration in minutes. */
|
|
9369
|
+
max: number;
|
|
9370
|
+
/** @description Minimum booking duration in minutes. */
|
|
9371
|
+
min: number;
|
|
9372
|
+
/** @description Duration limits for public bookers. */
|
|
9373
|
+
public: {
|
|
9374
|
+
/** @description Whether public bookers have separate duration limits. */
|
|
9375
|
+
enabled: boolean;
|
|
9376
|
+
/** @description Maximum booking duration in minutes for public bookers. */
|
|
9377
|
+
max: number;
|
|
9378
|
+
/** @description Minimum booking duration in minutes for public bookers. */
|
|
9379
|
+
min: number;
|
|
9380
|
+
};
|
|
9381
|
+
};
|
|
9382
|
+
/** @description Dynamic pricing settings. */
|
|
9383
|
+
dynamicPricing: {
|
|
9384
|
+
/** @description Maximum price increase percentage when demand is high. */
|
|
9385
|
+
deltaAbove: number;
|
|
9386
|
+
/** @description Maximum price decrease percentage when demand is low. */
|
|
9387
|
+
deltaBelow: number;
|
|
9388
|
+
/** @description Whether dynamic pricing is enabled. */
|
|
9389
|
+
enabled: boolean;
|
|
9390
|
+
};
|
|
9391
|
+
/** @description Google Calendar integration settings. */
|
|
9392
|
+
googleCalendar?: {
|
|
9393
|
+
/** @description Google Calendar id. */
|
|
9394
|
+
id: string;
|
|
9395
|
+
/** @description Whether two-way sync is enabled. */
|
|
9396
|
+
twoWaySyncEnabled: boolean;
|
|
9397
|
+
};
|
|
9398
|
+
/**
|
|
9399
|
+
* Format: uuid
|
|
9400
|
+
* @description Unique identifier of the resource.
|
|
9401
|
+
*/
|
|
9402
|
+
id: string;
|
|
9403
|
+
/** @description Public URL of the resource image. */
|
|
9404
|
+
imageUrl?: string;
|
|
9405
|
+
/** @description Kisi access group reference. */
|
|
9406
|
+
kisiGroupRef?: number | null;
|
|
9407
|
+
/** @description Auto-detected language of the description. */
|
|
9408
|
+
locale: string;
|
|
9409
|
+
/**
|
|
9410
|
+
* Format: uuid
|
|
9411
|
+
* @description ID of the location.
|
|
9412
|
+
*/
|
|
9413
|
+
locationRef: string;
|
|
9414
|
+
/** @description Images attached to the resource. */
|
|
9415
|
+
media: {
|
|
9416
|
+
/** @description Storage key of the image. */
|
|
9417
|
+
key: string;
|
|
9418
|
+
/** @description Public URL of the image. */
|
|
9419
|
+
url?: string;
|
|
9420
|
+
}[];
|
|
9421
|
+
/** @description Money pricing settings. */
|
|
9422
|
+
money: {
|
|
9423
|
+
/** @description Whether customers can pay with money. */
|
|
9424
|
+
enabled: boolean;
|
|
9425
|
+
/** @description Stepped money pricing tiers. */
|
|
9426
|
+
tiers: {
|
|
9427
|
+
/** @description Fixed fee added for this tier. */
|
|
9428
|
+
flatAmount: number;
|
|
9429
|
+
/** @description Start of this price tier in booking minutes. */
|
|
9430
|
+
from: number;
|
|
9431
|
+
/** @description Variable price per unit within this tier. */
|
|
9432
|
+
unitAmount: number;
|
|
9433
|
+
}[];
|
|
9434
|
+
};
|
|
9435
|
+
/**
|
|
9436
|
+
* Format: uuid
|
|
9437
|
+
* @description ID of the network.
|
|
9438
|
+
*/
|
|
9439
|
+
networkRef: string;
|
|
9440
|
+
/**
|
|
9441
|
+
* Format: uuid
|
|
9442
|
+
* @description Parent resource id when this is a child resource.
|
|
9443
|
+
*/
|
|
9444
|
+
parentRef?: string;
|
|
9445
|
+
/** @description Plan tiers configured on the resource. */
|
|
9446
|
+
plans?: {
|
|
9447
|
+
/** @description Whether plan-based access is enabled. */
|
|
9448
|
+
enabled: boolean;
|
|
9449
|
+
/** @description Plan tiers configured on the resource. */
|
|
9450
|
+
tiers: {
|
|
9451
|
+
/** @description Addons included in the tier. */
|
|
9452
|
+
addons: {
|
|
9453
|
+
/**
|
|
9454
|
+
* Format: uuid
|
|
9455
|
+
* @description Addon id.
|
|
9456
|
+
*/
|
|
9457
|
+
id: string;
|
|
9458
|
+
}[];
|
|
9459
|
+
/** @description Number of billing cycles in the tier. */
|
|
9460
|
+
commitmentCycles: number;
|
|
9461
|
+
/** @description Credits included in the tier. */
|
|
9462
|
+
credits: number;
|
|
9463
|
+
/** @description Day passes included in the tier. */
|
|
9464
|
+
dayPasses?: number;
|
|
9465
|
+
/** @description Description of the tier. */
|
|
9466
|
+
description?: string;
|
|
9467
|
+
/**
|
|
9468
|
+
* @deprecated
|
|
9469
|
+
* @description Synthetic discount percentages by product type.
|
|
9470
|
+
*/
|
|
9471
|
+
discounts?: {
|
|
9472
|
+
/** @description Discount percentage for credit packages. */
|
|
9473
|
+
creditPackages?: number;
|
|
9474
|
+
/** @description Discount percentage for desk bookings. */
|
|
9475
|
+
desks?: number;
|
|
9476
|
+
/** @description Discount percentage for equipment bookings. */
|
|
9477
|
+
equipment?: number;
|
|
9478
|
+
/** @description Discount percentage for events. */
|
|
9479
|
+
events?: number;
|
|
9480
|
+
/** @description Discount percentage for room bookings. */
|
|
9481
|
+
rooms?: number;
|
|
9482
|
+
/** @description Discount percentage for shop products. */
|
|
9483
|
+
shop?: number;
|
|
9484
|
+
};
|
|
9485
|
+
/** @description Whether the tier grants access to the entire resource. */
|
|
9486
|
+
entire: boolean;
|
|
9487
|
+
/** @description Coupons granted to members on this tier. */
|
|
9488
|
+
grantedDiscounts: {
|
|
9489
|
+
/** @description Granted coupon details. */
|
|
9490
|
+
coupon: {
|
|
9491
|
+
/** @description Fixed discount amount. */
|
|
9492
|
+
amountOff?: number;
|
|
9493
|
+
/** @description Currency code for amountOff. */
|
|
9494
|
+
currencyCode?: string;
|
|
9495
|
+
/** @description Whether the coupon applies to credit purchases. */
|
|
9496
|
+
enabledForCredits?: boolean;
|
|
9497
|
+
/**
|
|
9498
|
+
* Format: uuid
|
|
9499
|
+
* @description Unique identifier of the coupon.
|
|
9500
|
+
*/
|
|
9501
|
+
id: string;
|
|
9502
|
+
/** @description Item-level redemption limits. */
|
|
9503
|
+
limitedItems?: {
|
|
9504
|
+
/** @description Whether item-level limits are enabled. */
|
|
9505
|
+
enabled: boolean;
|
|
9506
|
+
/** @description Items the coupon applies to when limits are enabled. */
|
|
9507
|
+
values: {
|
|
9508
|
+
/**
|
|
9509
|
+
* Format: uuid
|
|
9510
|
+
* @description Unique identifier of the limited item.
|
|
9511
|
+
*/
|
|
9512
|
+
id: string;
|
|
9513
|
+
/** @description Display name of the limited item. */
|
|
9514
|
+
title?: string;
|
|
9515
|
+
/**
|
|
9516
|
+
* @description Product type of the limited item.
|
|
9517
|
+
* @enum {string}
|
|
9518
|
+
*/
|
|
9519
|
+
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
9520
|
+
}[];
|
|
9521
|
+
};
|
|
9522
|
+
/** @description Redemption limits for the coupon. */
|
|
9523
|
+
limitedRedemption?: {
|
|
9524
|
+
/** @description Whether redemption limits are enabled. */
|
|
9525
|
+
enabled: boolean;
|
|
9526
|
+
/** @description Current redemption count. */
|
|
9527
|
+
usage: number;
|
|
9528
|
+
/** @description Maximum redemption count. */
|
|
9529
|
+
value: number;
|
|
9530
|
+
};
|
|
9531
|
+
/** @description Percentage discount. */
|
|
9532
|
+
percentOff?: number;
|
|
9533
|
+
/** @description Product types the coupon applies to. */
|
|
9534
|
+
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
9535
|
+
};
|
|
9536
|
+
}[];
|
|
9537
|
+
/**
|
|
9538
|
+
* Format: uuid
|
|
9539
|
+
* @description Unique identifier of the tier.
|
|
9540
|
+
*/
|
|
9541
|
+
id: string;
|
|
9542
|
+
/**
|
|
9543
|
+
* @description Billing period of the tier.
|
|
9544
|
+
* @enum {string}
|
|
9545
|
+
*/
|
|
9546
|
+
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
9547
|
+
/** @description Nested plan details on responses. */
|
|
9548
|
+
plan: {
|
|
9549
|
+
/** @description Number of billing cycles in the tier. */
|
|
9550
|
+
commitmentCycles: number;
|
|
9551
|
+
/** @description Credits included in the tier. */
|
|
9552
|
+
credits: number;
|
|
9553
|
+
/** @description Day passes included in the tier. */
|
|
9554
|
+
dayPasses: number;
|
|
9555
|
+
/**
|
|
9556
|
+
* @deprecated
|
|
9557
|
+
* @description Synthetic discount percentages by product type.
|
|
9558
|
+
*/
|
|
9559
|
+
discounts?: {
|
|
9560
|
+
/** @description Discount percentage for credit packages. */
|
|
9561
|
+
creditPackages?: number;
|
|
9562
|
+
/** @description Discount percentage for desk bookings. */
|
|
9563
|
+
desks?: number;
|
|
9564
|
+
/** @description Discount percentage for equipment bookings. */
|
|
9565
|
+
equipment?: number;
|
|
9566
|
+
/** @description Discount percentage for events. */
|
|
9567
|
+
events?: number;
|
|
9568
|
+
/** @description Discount percentage for room bookings. */
|
|
9569
|
+
rooms?: number;
|
|
9570
|
+
/** @description Discount percentage for shop products. */
|
|
9571
|
+
shop?: number;
|
|
9572
|
+
};
|
|
9573
|
+
/** @description Coupons granted to members on this tier. */
|
|
9574
|
+
grantedDiscounts: {
|
|
9575
|
+
/** @description Granted coupon details. */
|
|
9576
|
+
coupon: {
|
|
9577
|
+
/** @description Fixed discount amount. */
|
|
9578
|
+
amountOff?: number;
|
|
9579
|
+
/** @description Currency code for amountOff. */
|
|
9580
|
+
currencyCode?: string;
|
|
9581
|
+
/** @description Whether the coupon applies to credit purchases. */
|
|
9582
|
+
enabledForCredits?: boolean;
|
|
9583
|
+
/**
|
|
9584
|
+
* Format: uuid
|
|
9585
|
+
* @description Unique identifier of the coupon.
|
|
9586
|
+
*/
|
|
9587
|
+
id: string;
|
|
9588
|
+
/** @description Item-level redemption limits. */
|
|
9589
|
+
limitedItems?: {
|
|
9590
|
+
/** @description Whether item-level limits are enabled. */
|
|
9591
|
+
enabled: boolean;
|
|
9592
|
+
/** @description Items the coupon applies to when limits are enabled. */
|
|
9593
|
+
values: {
|
|
9594
|
+
/**
|
|
9595
|
+
* Format: uuid
|
|
9596
|
+
* @description Unique identifier of the limited item.
|
|
9597
|
+
*/
|
|
9598
|
+
id: string;
|
|
9599
|
+
/** @description Display name of the limited item. */
|
|
9600
|
+
title?: string;
|
|
9601
|
+
/**
|
|
9602
|
+
* @description Product type of the limited item.
|
|
9603
|
+
* @enum {string}
|
|
9604
|
+
*/
|
|
9605
|
+
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
9606
|
+
}[];
|
|
9607
|
+
};
|
|
9608
|
+
/** @description Redemption limits for the coupon. */
|
|
9609
|
+
limitedRedemption?: {
|
|
9610
|
+
/** @description Whether redemption limits are enabled. */
|
|
9611
|
+
enabled: boolean;
|
|
9612
|
+
/** @description Current redemption count. */
|
|
9613
|
+
usage: number;
|
|
9614
|
+
/** @description Maximum redemption count. */
|
|
9615
|
+
value: number;
|
|
9616
|
+
};
|
|
9617
|
+
/** @description Percentage discount. */
|
|
9618
|
+
percentOff?: number;
|
|
9619
|
+
/** @description Product types the coupon applies to. */
|
|
9620
|
+
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
9621
|
+
};
|
|
9622
|
+
}[];
|
|
9623
|
+
/**
|
|
9624
|
+
* Format: uuid
|
|
9625
|
+
* @description Unique identifier of the tier.
|
|
9626
|
+
*/
|
|
9627
|
+
id: string;
|
|
9628
|
+
/**
|
|
9629
|
+
* @description Billing period of the tier.
|
|
9630
|
+
* @enum {string}
|
|
9631
|
+
*/
|
|
9632
|
+
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
9633
|
+
/** @description Price of the tier. */
|
|
9634
|
+
price: number;
|
|
9635
|
+
/** @description Title of the tier. */
|
|
9636
|
+
title: string;
|
|
9637
|
+
};
|
|
9638
|
+
/** @description Price of the tier. */
|
|
9639
|
+
price: number;
|
|
9640
|
+
/** @description Self sign-up settings of the tier. */
|
|
9641
|
+
selfSignup: {
|
|
9642
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
9643
|
+
enabled: boolean;
|
|
9644
|
+
/** @description Self sign-up flow type for the tier. */
|
|
9645
|
+
type: string;
|
|
9646
|
+
};
|
|
9647
|
+
/**
|
|
9648
|
+
* @deprecated
|
|
9649
|
+
* @description Deprecated. Use selfSignup.type instead. Self sign-up flow type for the tier.
|
|
9650
|
+
*/
|
|
9651
|
+
selfSignupType?: string;
|
|
9652
|
+
/** @description One-time setup fee for the tier. */
|
|
9653
|
+
setupFee: number;
|
|
9654
|
+
/** @description Title of the tier. */
|
|
9655
|
+
title: string;
|
|
9656
|
+
}[];
|
|
9657
|
+
};
|
|
9658
|
+
/**
|
|
9659
|
+
* @deprecated
|
|
9660
|
+
* @description Deprecated. Use bufferTime instead.
|
|
9661
|
+
* @enum {string}
|
|
9662
|
+
*/
|
|
9663
|
+
preparationMinutes: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
9664
|
+
/**
|
|
9665
|
+
* @description Refund threshold for cancellations.
|
|
9666
|
+
* @enum {string}
|
|
9667
|
+
*/
|
|
9668
|
+
refundThreshold: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
9669
|
+
/**
|
|
9670
|
+
* Format: uuid
|
|
9671
|
+
* @description Salto KS access group reference.
|
|
9672
|
+
*/
|
|
9673
|
+
saltoksAccessGroupRef?: string | null;
|
|
9674
|
+
/** @description Availability schedule. */
|
|
9675
|
+
schedule?: {
|
|
9676
|
+
/** @description Default availability schedule. */
|
|
9677
|
+
default: {
|
|
9678
|
+
/** @description Dates in MM-DD format when the resource is closed. */
|
|
9679
|
+
closedDays: string[];
|
|
9680
|
+
/** @description Weekly availability windows for members. */
|
|
9681
|
+
items: {
|
|
9682
|
+
/** @description Weekdays this time window applies to. */
|
|
9683
|
+
days: {
|
|
9684
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9685
|
+
friday: boolean;
|
|
9686
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9687
|
+
monday: boolean;
|
|
9688
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9689
|
+
saturday: boolean;
|
|
9690
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9691
|
+
sunday: boolean;
|
|
9692
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9693
|
+
thursday: boolean;
|
|
9694
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9695
|
+
tuesday: boolean;
|
|
9696
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9697
|
+
wednesday: boolean;
|
|
9698
|
+
};
|
|
9699
|
+
/** @description Open hours for the selected weekdays. */
|
|
9700
|
+
hours: {
|
|
9701
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9702
|
+
from: string;
|
|
9703
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9704
|
+
to: string;
|
|
9705
|
+
};
|
|
9706
|
+
}[];
|
|
9707
|
+
};
|
|
9708
|
+
/** @description Whether scheduling is enabled. */
|
|
9709
|
+
enabled: boolean;
|
|
9710
|
+
/** @description Public availability schedule. */
|
|
9711
|
+
public: {
|
|
9712
|
+
/** @description Dates in MM-DD format when the resource is closed for public bookers. */
|
|
9713
|
+
closedDays: string[];
|
|
9714
|
+
/** @description Whether the public schedule is enabled. */
|
|
9715
|
+
enabled: boolean;
|
|
9716
|
+
/** @description Weekly availability windows for public bookers. */
|
|
9717
|
+
items: {
|
|
9718
|
+
/** @description Weekdays this time window applies to. */
|
|
9719
|
+
days: {
|
|
9720
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9721
|
+
friday: boolean;
|
|
9722
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9723
|
+
monday: boolean;
|
|
9724
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9725
|
+
saturday: boolean;
|
|
9726
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9727
|
+
sunday: boolean;
|
|
9728
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9729
|
+
thursday: boolean;
|
|
9730
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9731
|
+
tuesday: boolean;
|
|
9732
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9733
|
+
wednesday: boolean;
|
|
9734
|
+
};
|
|
9735
|
+
/** @description Open hours for the selected weekdays. */
|
|
9736
|
+
hours: {
|
|
9737
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9738
|
+
from: string;
|
|
9739
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9740
|
+
to: string;
|
|
9741
|
+
};
|
|
9742
|
+
}[];
|
|
9743
|
+
};
|
|
9744
|
+
};
|
|
9745
|
+
/**
|
|
9746
|
+
* Format: uuid
|
|
9747
|
+
* @description Tapkey access group reference.
|
|
9748
|
+
*/
|
|
9749
|
+
tapkeyGroupRef?: string | null;
|
|
9750
|
+
/** @description Display name of the resource. */
|
|
9751
|
+
title: string;
|
|
9752
|
+
/**
|
|
9753
|
+
* @description Type of the resource.
|
|
9754
|
+
* @enum {string}
|
|
9755
|
+
*/
|
|
9756
|
+
type: "dedicatedDesk" | "equipment" | "hotDesk" | "office" | "parkingLot" | "room" | "station" | "conferenceRoom" | "eventSpace" | "meetingRoom" | "phoneBooth" | "studio";
|
|
9757
|
+
/**
|
|
9758
|
+
* @description Visibility of the resource.
|
|
9759
|
+
* @enum {string}
|
|
9760
|
+
*/
|
|
9761
|
+
visibility: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9762
|
+
};
|
|
9763
|
+
};
|
|
9764
|
+
getAssignments: {
|
|
9765
|
+
/** @description List of resource assignments in the location. */
|
|
9766
|
+
assignments: {
|
|
9767
|
+
/**
|
|
9768
|
+
* @deprecated
|
|
9769
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
9770
|
+
*/
|
|
9771
|
+
company?: {
|
|
9772
|
+
/**
|
|
9773
|
+
* Format: uuid
|
|
9774
|
+
* @description Company id.
|
|
9775
|
+
*/
|
|
9776
|
+
id: string;
|
|
9777
|
+
/** @description Company name. */
|
|
9778
|
+
title: string;
|
|
9779
|
+
};
|
|
9780
|
+
/** @description Customer the resource is assigned to. */
|
|
9781
|
+
customer?: {
|
|
9782
|
+
/**
|
|
9783
|
+
* Format: uuid
|
|
9784
|
+
* @description Customer id.
|
|
9785
|
+
*/
|
|
9786
|
+
id: string;
|
|
9787
|
+
/** @description Company name when the customer is a company. */
|
|
9788
|
+
title?: string;
|
|
9789
|
+
/**
|
|
9790
|
+
* @description Whether the customer is a user or company.
|
|
9791
|
+
* @enum {string}
|
|
9792
|
+
*/
|
|
9793
|
+
type: "user" | "company";
|
|
9794
|
+
/** @description User details when the customer is a user. */
|
|
9795
|
+
user?: {
|
|
9796
|
+
/** @description User email. */
|
|
9797
|
+
email?: string | null;
|
|
9798
|
+
/**
|
|
9799
|
+
* Format: uuid
|
|
9800
|
+
* @description User id.
|
|
9801
|
+
*/
|
|
9802
|
+
id: string;
|
|
9803
|
+
/** @description User first name. */
|
|
9804
|
+
name?: string | null;
|
|
9805
|
+
/** @description User last name. */
|
|
9806
|
+
surname?: string | null;
|
|
9807
|
+
};
|
|
9808
|
+
};
|
|
9809
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
9810
|
+
entire: boolean;
|
|
9811
|
+
/**
|
|
9812
|
+
* Format: uuid
|
|
9813
|
+
* @description Assignment id.
|
|
9814
|
+
*/
|
|
9815
|
+
id?: string;
|
|
9816
|
+
/**
|
|
9817
|
+
* @deprecated
|
|
9818
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
9819
|
+
*/
|
|
9820
|
+
membership?: {
|
|
9821
|
+
/**
|
|
9822
|
+
* Format: uuid
|
|
9823
|
+
* @description Membership id.
|
|
9824
|
+
*/
|
|
9825
|
+
id: string;
|
|
9826
|
+
};
|
|
9827
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9828
|
+
quantity?: number;
|
|
9829
|
+
/**
|
|
9830
|
+
* Format: uuid
|
|
9831
|
+
* @description UUID of the resource the assignment belongs to.
|
|
9832
|
+
*/
|
|
9833
|
+
resourceRef: string;
|
|
9834
|
+
/** @description Subscription backing this assignment. */
|
|
9835
|
+
subscription: {
|
|
9836
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
9837
|
+
endDate?: string;
|
|
9838
|
+
/**
|
|
9839
|
+
* Format: uuid
|
|
9840
|
+
* @description Subscription id.
|
|
9841
|
+
*/
|
|
9842
|
+
id: string;
|
|
9843
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
9844
|
+
startDate: string;
|
|
9845
|
+
};
|
|
9846
|
+
/**
|
|
9847
|
+
* @deprecated
|
|
9848
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
9849
|
+
*/
|
|
9850
|
+
user?: {
|
|
9851
|
+
/** @description User email. */
|
|
9852
|
+
email?: string | null;
|
|
9853
|
+
/**
|
|
9854
|
+
* Format: uuid
|
|
9855
|
+
* @description User id.
|
|
9856
|
+
*/
|
|
9857
|
+
id: string;
|
|
9858
|
+
/** @description User first name. */
|
|
9859
|
+
name?: string | null;
|
|
9860
|
+
/** @description User last name. */
|
|
9861
|
+
surname?: string | null;
|
|
9862
|
+
};
|
|
9863
|
+
}[];
|
|
9864
|
+
};
|
|
9865
|
+
getBookings: {
|
|
9866
|
+
/** @description List of bookings. */
|
|
9867
|
+
bookings: {
|
|
9868
|
+
/** @description Attendees of the booking. Empty when the caller has no access to booking details. */
|
|
9869
|
+
attendees: {
|
|
9870
|
+
/**
|
|
9871
|
+
* Format: uuid
|
|
9872
|
+
* @description Membership id of the attendee.
|
|
9873
|
+
*/
|
|
9874
|
+
membershipRef?: string;
|
|
9875
|
+
/** @description User profile of the attendee. */
|
|
9876
|
+
user?: {
|
|
9877
|
+
/** @description Short bio of the user. */
|
|
9878
|
+
about?: string | null;
|
|
9879
|
+
/** @description Company the user belongs to, if any. */
|
|
9880
|
+
company?: {
|
|
9881
|
+
/** @description Company display name. */
|
|
9882
|
+
title: string;
|
|
9883
|
+
} | null;
|
|
9884
|
+
/**
|
|
9885
|
+
* Format: email
|
|
9886
|
+
* @description Email address of the user.
|
|
9887
|
+
*/
|
|
9888
|
+
email?: string | null;
|
|
9889
|
+
/**
|
|
9890
|
+
* Format: uuid
|
|
9891
|
+
* @description Unique identifier of the user.
|
|
9892
|
+
*/
|
|
9893
|
+
id: string;
|
|
9894
|
+
/** @description First name of the user. */
|
|
9895
|
+
name?: string | null;
|
|
9896
|
+
/** @description Phone number of the user. */
|
|
9897
|
+
phoneNumber?: string | null;
|
|
9898
|
+
/** @description Profile photo URL of the user. */
|
|
9899
|
+
photoUrl?: string | null;
|
|
9900
|
+
/** @description Last name of the user. */
|
|
9901
|
+
surname?: string | null;
|
|
9902
|
+
};
|
|
9903
|
+
}[];
|
|
9904
|
+
/**
|
|
9905
|
+
* Format: date-time
|
|
9906
|
+
* @description ISO timestamp when the booking was created.
|
|
9907
|
+
*/
|
|
9908
|
+
createDate: string;
|
|
9909
|
+
/**
|
|
9910
|
+
* Format: date-time
|
|
9911
|
+
* @description ISO timestamp when the booking was cancelled.
|
|
9912
|
+
*/
|
|
9913
|
+
deleteDate?: string;
|
|
9914
|
+
/**
|
|
9915
|
+
* Format: date-time
|
|
9916
|
+
* @description ISO timestamp when the booking ends.
|
|
9917
|
+
*/
|
|
9918
|
+
endDate: string;
|
|
9919
|
+
/** @description Whether the booking reserves the entire resource rather than individual seats. */
|
|
9920
|
+
entire?: boolean;
|
|
9921
|
+
/** @description Unique identifier of the booking. For recurring occurrences, formatted as `{bookingId}_{isoDate}`. */
|
|
9922
|
+
id: string;
|
|
9923
|
+
/**
|
|
9924
|
+
* Format: uuid
|
|
9925
|
+
* @deprecated
|
|
9926
|
+
* @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
|
|
9927
|
+
*/
|
|
9928
|
+
membershipRefOwner?: string;
|
|
9929
|
+
/** @description Internal note. Visible to admins only. */
|
|
9930
|
+
memo?: string;
|
|
9931
|
+
/**
|
|
9932
|
+
* @deprecated
|
|
9933
|
+
* @description Deprecated. Use `payments` instead.
|
|
9934
|
+
*/
|
|
9935
|
+
payment?: {
|
|
9936
|
+
/** @description Payment amount in the location currency. */
|
|
9937
|
+
amount?: number;
|
|
9938
|
+
/** @description ISO 4217 currency code. */
|
|
9939
|
+
currencyCode?: string;
|
|
9940
|
+
/** @description ID of the associated invoice item. */
|
|
9941
|
+
invoiceItemRef?: string;
|
|
9942
|
+
/**
|
|
9943
|
+
* @description Payment status.
|
|
9944
|
+
* @enum {string}
|
|
9945
|
+
*/
|
|
9946
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
9947
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
9948
|
+
surcharge?: {
|
|
9949
|
+
money: {
|
|
9950
|
+
/** @description Surcharge amount. */
|
|
9951
|
+
amount?: number;
|
|
9952
|
+
/** @description ISO 4217 currency code. */
|
|
9953
|
+
currencyCode?: string;
|
|
9954
|
+
/** @description Surcharge percentage applied. */
|
|
9955
|
+
percentage?: number;
|
|
9956
|
+
/** @description Surcharge rate. */
|
|
9957
|
+
rate?: number;
|
|
9958
|
+
};
|
|
9959
|
+
/**
|
|
9960
|
+
* @description Surcharge type.
|
|
9961
|
+
* @enum {string}
|
|
9962
|
+
*/
|
|
9963
|
+
type: "money";
|
|
9964
|
+
};
|
|
9965
|
+
/** @description ID of the associated transaction. */
|
|
9966
|
+
transactionRef?: string;
|
|
9967
|
+
/** @description Payment method type. */
|
|
9968
|
+
type?: string;
|
|
9969
|
+
};
|
|
9970
|
+
/** @description Payment details. Omitted when caller has no access. */
|
|
9971
|
+
payments?: {
|
|
9972
|
+
/** @description Payment amount in the location currency. */
|
|
9973
|
+
amount?: number;
|
|
9974
|
+
/** @description ISO 4217 currency code. */
|
|
9975
|
+
currencyCode?: string;
|
|
9976
|
+
/** @description ID of the associated invoice item. */
|
|
9977
|
+
invoiceItemRef?: string;
|
|
9978
|
+
/**
|
|
9979
|
+
* @description Payment status.
|
|
9980
|
+
* @enum {string}
|
|
9981
|
+
*/
|
|
9982
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
9983
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
9984
|
+
surcharge?: {
|
|
9985
|
+
money: {
|
|
9986
|
+
/** @description Surcharge amount. */
|
|
9987
|
+
amount?: number;
|
|
9988
|
+
/** @description ISO 4217 currency code. */
|
|
9989
|
+
currencyCode?: string;
|
|
9990
|
+
/** @description Surcharge percentage applied. */
|
|
9991
|
+
percentage?: number;
|
|
9992
|
+
/** @description Surcharge rate. */
|
|
9993
|
+
rate?: number;
|
|
9994
|
+
};
|
|
9995
|
+
/**
|
|
9996
|
+
* @description Surcharge type.
|
|
9997
|
+
* @enum {string}
|
|
9998
|
+
*/
|
|
9999
|
+
type: "money";
|
|
10000
|
+
};
|
|
10001
|
+
/** @description ID of the associated transaction. */
|
|
10002
|
+
transactionRef?: string;
|
|
10003
|
+
/** @description Payment method type. */
|
|
10004
|
+
type?: string;
|
|
10005
|
+
}[];
|
|
10006
|
+
/**
|
|
10007
|
+
* Format: uuid
|
|
10008
|
+
* @description ID of the booked resource.
|
|
10009
|
+
*/
|
|
10010
|
+
resourceRef: string;
|
|
10011
|
+
/** @description Number of seats reserved. */
|
|
10012
|
+
seats?: number;
|
|
10013
|
+
/**
|
|
10014
|
+
* Format: date-time
|
|
10015
|
+
* @description ISO timestamp when the booking starts.
|
|
10016
|
+
*/
|
|
10017
|
+
startDate: string;
|
|
10018
|
+
/** @description Custom booking title. Omitted when the owner has restricted title visibility. */
|
|
10019
|
+
title?: string;
|
|
10020
|
+
/**
|
|
10021
|
+
* Format: date-time
|
|
10022
|
+
* @description ISO timestamp when the booking was last updated.
|
|
10023
|
+
*/
|
|
10024
|
+
updateDate?: string;
|
|
10025
|
+
/** @description Profile of the booking owner. Omitted when the owner has restricted visibility. */
|
|
10026
|
+
userOwner?: {
|
|
10027
|
+
/** @description Short bio of the user. */
|
|
10028
|
+
about?: string | null;
|
|
10029
|
+
/** @description Company the user belongs to, if any. */
|
|
10030
|
+
company?: {
|
|
10031
|
+
/** @description Company display name. */
|
|
10032
|
+
title: string;
|
|
10033
|
+
} | null;
|
|
10034
|
+
/**
|
|
10035
|
+
* Format: email
|
|
10036
|
+
* @description Email address of the user.
|
|
10037
|
+
*/
|
|
10038
|
+
email?: string | null;
|
|
10039
|
+
/**
|
|
10040
|
+
* Format: uuid
|
|
10041
|
+
* @description Unique identifier of the user.
|
|
10042
|
+
*/
|
|
10043
|
+
id: string;
|
|
10044
|
+
/** @description First name of the user. */
|
|
10045
|
+
name?: string | null;
|
|
10046
|
+
/** @description Phone number of the user. */
|
|
10047
|
+
phoneNumber?: string | null;
|
|
10048
|
+
/** @description Profile photo URL of the user. */
|
|
10049
|
+
photoUrl?: string | null;
|
|
10050
|
+
/** @description Last name of the user. */
|
|
10051
|
+
surname?: string | null;
|
|
10052
|
+
};
|
|
10053
|
+
}[];
|
|
10054
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
10055
|
+
nextPageToken?: string;
|
|
10056
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
10057
|
+
searchQueryNext?: string;
|
|
10058
|
+
};
|
|
10059
|
+
getBooking: {
|
|
10060
|
+
/** @description The booking. */
|
|
10061
|
+
booking: {
|
|
10062
|
+
/** @description Attendees of the booking. Empty when the caller has no access to booking details. */
|
|
10063
|
+
attendees: {
|
|
10064
|
+
/**
|
|
10065
|
+
* Format: uuid
|
|
10066
|
+
* @description Membership id of the attendee.
|
|
10067
|
+
*/
|
|
10068
|
+
membershipRef?: string;
|
|
10069
|
+
/** @description User profile of the attendee. */
|
|
10070
|
+
user?: {
|
|
10071
|
+
/** @description Short bio of the user. */
|
|
10072
|
+
about?: string | null;
|
|
10073
|
+
/** @description Company the user belongs to, if any. */
|
|
10074
|
+
company?: {
|
|
10075
|
+
/** @description Company display name. */
|
|
10076
|
+
title: string;
|
|
10077
|
+
} | null;
|
|
10078
|
+
/**
|
|
10079
|
+
* Format: email
|
|
10080
|
+
* @description Email address of the user.
|
|
10081
|
+
*/
|
|
10082
|
+
email?: string | null;
|
|
10083
|
+
/**
|
|
10084
|
+
* Format: uuid
|
|
10085
|
+
* @description Unique identifier of the user.
|
|
10086
|
+
*/
|
|
10087
|
+
id: string;
|
|
10088
|
+
/** @description First name of the user. */
|
|
10089
|
+
name?: string | null;
|
|
10090
|
+
/** @description Phone number of the user. */
|
|
10091
|
+
phoneNumber?: string | null;
|
|
10092
|
+
/** @description Profile photo URL of the user. */
|
|
10093
|
+
photoUrl?: string | null;
|
|
10094
|
+
/** @description Last name of the user. */
|
|
10095
|
+
surname?: string | null;
|
|
10096
|
+
};
|
|
10097
|
+
}[];
|
|
10098
|
+
/**
|
|
10099
|
+
* Format: date-time
|
|
10100
|
+
* @description ISO timestamp when the booking was created.
|
|
10101
|
+
*/
|
|
10102
|
+
createDate: string;
|
|
10103
|
+
/**
|
|
10104
|
+
* Format: date-time
|
|
10105
|
+
* @description ISO timestamp when the booking was cancelled.
|
|
10106
|
+
*/
|
|
10107
|
+
deleteDate?: string;
|
|
10108
|
+
/**
|
|
10109
|
+
* Format: date-time
|
|
10110
|
+
* @description ISO timestamp when the booking ends.
|
|
10111
|
+
*/
|
|
10112
|
+
endDate: string;
|
|
10113
|
+
/** @description Whether the booking reserves the entire resource rather than individual seats. */
|
|
10114
|
+
entire?: boolean;
|
|
10115
|
+
/** @description Unique identifier of the booking. For recurring occurrences, formatted as `{bookingId}_{isoDate}`. */
|
|
10116
|
+
id: string;
|
|
10117
|
+
/**
|
|
10118
|
+
* Format: uuid
|
|
10119
|
+
* @deprecated
|
|
10120
|
+
* @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
|
|
10121
|
+
*/
|
|
10122
|
+
membershipRefOwner?: string;
|
|
10123
|
+
/** @description Internal note. Visible to admins only. */
|
|
10124
|
+
memo?: string;
|
|
10125
|
+
/**
|
|
10126
|
+
* @deprecated
|
|
10127
|
+
* @description Deprecated. Use `payments` instead.
|
|
10128
|
+
*/
|
|
10129
|
+
payment?: {
|
|
10130
|
+
/** @description Payment amount in the location currency. */
|
|
10131
|
+
amount?: number;
|
|
10132
|
+
/** @description ISO 4217 currency code. */
|
|
10133
|
+
currencyCode?: string;
|
|
10134
|
+
/** @description ID of the associated invoice item. */
|
|
10135
|
+
invoiceItemRef?: string;
|
|
10136
|
+
/**
|
|
10137
|
+
* @description Payment status.
|
|
10138
|
+
* @enum {string}
|
|
10139
|
+
*/
|
|
10140
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10141
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
10142
|
+
surcharge?: {
|
|
10143
|
+
money: {
|
|
10144
|
+
/** @description Surcharge amount. */
|
|
10145
|
+
amount?: number;
|
|
10146
|
+
/** @description ISO 4217 currency code. */
|
|
10147
|
+
currencyCode?: string;
|
|
10148
|
+
/** @description Surcharge percentage applied. */
|
|
10149
|
+
percentage?: number;
|
|
10150
|
+
/** @description Surcharge rate. */
|
|
10151
|
+
rate?: number;
|
|
10152
|
+
};
|
|
10153
|
+
/**
|
|
10154
|
+
* @description Surcharge type.
|
|
10155
|
+
* @enum {string}
|
|
10156
|
+
*/
|
|
10157
|
+
type: "money";
|
|
10158
|
+
};
|
|
10159
|
+
/** @description ID of the associated transaction. */
|
|
10160
|
+
transactionRef?: string;
|
|
10161
|
+
/** @description Payment method type. */
|
|
10162
|
+
type?: string;
|
|
10163
|
+
};
|
|
10164
|
+
/** @description Payment details. Omitted when caller has no access. */
|
|
10165
|
+
payments?: {
|
|
10166
|
+
/** @description Payment amount in the location currency. */
|
|
10167
|
+
amount?: number;
|
|
10168
|
+
/** @description ISO 4217 currency code. */
|
|
10169
|
+
currencyCode?: string;
|
|
10170
|
+
/** @description ID of the associated invoice item. */
|
|
10171
|
+
invoiceItemRef?: string;
|
|
10172
|
+
/**
|
|
10173
|
+
* @description Payment status.
|
|
10174
|
+
* @enum {string}
|
|
10175
|
+
*/
|
|
10176
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10177
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
10178
|
+
surcharge?: {
|
|
10179
|
+
money: {
|
|
10180
|
+
/** @description Surcharge amount. */
|
|
10181
|
+
amount?: number;
|
|
10182
|
+
/** @description ISO 4217 currency code. */
|
|
10183
|
+
currencyCode?: string;
|
|
10184
|
+
/** @description Surcharge percentage applied. */
|
|
10185
|
+
percentage?: number;
|
|
10186
|
+
/** @description Surcharge rate. */
|
|
10187
|
+
rate?: number;
|
|
10188
|
+
};
|
|
10189
|
+
/**
|
|
10190
|
+
* @description Surcharge type.
|
|
10191
|
+
* @enum {string}
|
|
10192
|
+
*/
|
|
10193
|
+
type: "money";
|
|
10194
|
+
};
|
|
10195
|
+
/** @description ID of the associated transaction. */
|
|
10196
|
+
transactionRef?: string;
|
|
10197
|
+
/** @description Payment method type. */
|
|
10198
|
+
type?: string;
|
|
10199
|
+
}[];
|
|
9146
10200
|
/**
|
|
9147
10201
|
* Format: uuid
|
|
9148
|
-
* @description
|
|
10202
|
+
* @description ID of the booked resource.
|
|
9149
10203
|
*/
|
|
9150
|
-
|
|
9151
|
-
/** @description
|
|
9152
|
-
|
|
9153
|
-
/**
|
|
9154
|
-
* Format: uuid
|
|
9155
|
-
* @description Membership id.
|
|
9156
|
-
*/
|
|
9157
|
-
id: string;
|
|
9158
|
-
};
|
|
9159
|
-
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9160
|
-
quantity?: number;
|
|
10204
|
+
resourceRef: string;
|
|
10205
|
+
/** @description Number of seats reserved. */
|
|
10206
|
+
seats?: number;
|
|
9161
10207
|
/**
|
|
9162
|
-
* Format:
|
|
9163
|
-
* @description
|
|
10208
|
+
* Format: date-time
|
|
10209
|
+
* @description ISO timestamp when the booking starts.
|
|
9164
10210
|
*/
|
|
9165
|
-
|
|
9166
|
-
/** @description
|
|
9167
|
-
|
|
9168
|
-
|
|
9169
|
-
|
|
10211
|
+
startDate: string;
|
|
10212
|
+
/** @description Custom booking title. Omitted when the owner has restricted title visibility. */
|
|
10213
|
+
title?: string;
|
|
10214
|
+
/**
|
|
10215
|
+
* Format: date-time
|
|
10216
|
+
* @description ISO timestamp when the booking was last updated.
|
|
10217
|
+
*/
|
|
10218
|
+
updateDate?: string;
|
|
10219
|
+
/** @description Profile of the booking owner. Omitted when the owner has restricted visibility. */
|
|
10220
|
+
userOwner?: {
|
|
10221
|
+
/** @description Short bio of the user. */
|
|
10222
|
+
about?: string | null;
|
|
10223
|
+
/** @description Company the user belongs to, if any. */
|
|
10224
|
+
company?: {
|
|
10225
|
+
/** @description Company display name. */
|
|
10226
|
+
title: string;
|
|
10227
|
+
} | null;
|
|
9170
10228
|
/**
|
|
9171
|
-
* Format:
|
|
9172
|
-
* @description
|
|
10229
|
+
* Format: email
|
|
10230
|
+
* @description Email address of the user.
|
|
9173
10231
|
*/
|
|
9174
|
-
id: string;
|
|
9175
|
-
/** @description ISO timestamp when the assignment starts. */
|
|
9176
|
-
startDate: string;
|
|
9177
|
-
};
|
|
9178
|
-
/** @description User assigned to the resource. */
|
|
9179
|
-
user?: {
|
|
9180
|
-
/** @description User email. */
|
|
9181
10232
|
email?: string | null;
|
|
9182
10233
|
/**
|
|
9183
10234
|
* Format: uuid
|
|
9184
|
-
* @description
|
|
10235
|
+
* @description Unique identifier of the user.
|
|
9185
10236
|
*/
|
|
9186
10237
|
id: string;
|
|
9187
|
-
/** @description
|
|
10238
|
+
/** @description First name of the user. */
|
|
9188
10239
|
name?: string | null;
|
|
9189
|
-
/** @description
|
|
10240
|
+
/** @description Phone number of the user. */
|
|
10241
|
+
phoneNumber?: string | null;
|
|
10242
|
+
/** @description Profile photo URL of the user. */
|
|
10243
|
+
photoUrl?: string | null;
|
|
10244
|
+
/** @description Last name of the user. */
|
|
9190
10245
|
surname?: string | null;
|
|
9191
10246
|
};
|
|
9192
|
-
}[];
|
|
9193
|
-
};
|
|
9194
|
-
payment: {
|
|
9195
|
-
/** @description The amount of the payment */
|
|
9196
|
-
amount?: number;
|
|
9197
|
-
/** @description The currency code of the payment */
|
|
9198
|
-
currencyCode?: string;
|
|
9199
|
-
/** @description The reference ID of the invoice item */
|
|
9200
|
-
invoiceItemRef?: string;
|
|
9201
|
-
/** @enum {string} */
|
|
9202
|
-
status?: "succeeded" | "pending" | "processing" | "canceled" | "failed";
|
|
9203
|
-
tax?: {
|
|
9204
|
-
inclusive?: boolean;
|
|
9205
|
-
rate?: number;
|
|
9206
10247
|
};
|
|
9207
|
-
/** @description The reference ID of the transaction */
|
|
9208
|
-
transactionRef?: string;
|
|
9209
|
-
/** @enum {string} */
|
|
9210
|
-
type?: "credits" | "dayPasses" | "external" | "flow" | "fondy" | "freedompay" | "invoice" | "kakaopay" | "mercadopago" | "paypal" | "paystack" | "plata" | "stripe" | "tap" | "wayforpay";
|
|
9211
|
-
};
|
|
9212
|
-
booking: {
|
|
9213
|
-
attendees?: {
|
|
9214
|
-
/** Format: uuid */
|
|
9215
|
-
membershipRef?: string;
|
|
9216
|
-
user?: components["schemas"]["user"];
|
|
9217
|
-
}[];
|
|
9218
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
9219
|
-
deleteDate?: components["schemas"]["dateSchema"];
|
|
9220
|
-
endDate?: components["schemas"]["dateSchema"];
|
|
9221
|
-
/** Format: uuid */
|
|
9222
|
-
id?: string;
|
|
9223
|
-
memo?: string;
|
|
9224
|
-
/** Format: uuid */
|
|
9225
|
-
membershipRefOwner?: string;
|
|
9226
|
-
/**
|
|
9227
|
-
* @deprecated
|
|
9228
|
-
* @description Deprecated. Use `payments` instead.
|
|
9229
|
-
*/
|
|
9230
|
-
payment?: components["schemas"]["payment"];
|
|
9231
|
-
/** @description Booking payments. Multiple entries when the booking has several ledger transactions. */
|
|
9232
|
-
payments?: components["schemas"]["payment"][];
|
|
9233
|
-
/** Format: uuid */
|
|
9234
|
-
resourceRef?: string;
|
|
9235
|
-
seats?: number;
|
|
9236
|
-
startDate?: components["schemas"]["dateSchema"];
|
|
9237
|
-
title?: string;
|
|
9238
|
-
updateDate?: components["schemas"]["dateSchema"];
|
|
9239
|
-
userOwner?: components["schemas"]["user"];
|
|
9240
10248
|
};
|
|
9241
10249
|
getShopCategories: {
|
|
9242
10250
|
/** @description List of shop categories. */
|
|
@@ -10917,8 +11925,10 @@ interface components {
|
|
|
10917
11925
|
endFixed: boolean;
|
|
10918
11926
|
/** @description Whether the item grants access to the entire resource. */
|
|
10919
11927
|
entire?: boolean;
|
|
10920
|
-
/** @description Resources with exclusive access. */
|
|
11928
|
+
/** @description Resources and benefits with exclusive access. */
|
|
10921
11929
|
exclusiveAccess?: {
|
|
11930
|
+
/** @description Benefit IDs with exclusive access. */
|
|
11931
|
+
benefitRefs: string[];
|
|
10922
11932
|
/** @description Resource IDs with exclusive access. */
|
|
10923
11933
|
resourceRefs: string[];
|
|
10924
11934
|
};
|
|
@@ -11490,8 +12500,10 @@ interface components {
|
|
|
11490
12500
|
endFixed: boolean;
|
|
11491
12501
|
/** @description Whether the item grants access to the entire resource. */
|
|
11492
12502
|
entire?: boolean;
|
|
11493
|
-
/** @description Resources with exclusive access. */
|
|
12503
|
+
/** @description Resources and benefits with exclusive access. */
|
|
11494
12504
|
exclusiveAccess?: {
|
|
12505
|
+
/** @description Benefit IDs with exclusive access. */
|
|
12506
|
+
benefitRefs: string[];
|
|
11495
12507
|
/** @description Resource IDs with exclusive access. */
|
|
11496
12508
|
resourceRefs: string[];
|
|
11497
12509
|
};
|
|
@@ -12064,8 +13076,10 @@ interface components {
|
|
|
12064
13076
|
endFixed: boolean;
|
|
12065
13077
|
/** @description Whether the item grants access to the entire resource. */
|
|
12066
13078
|
entire?: boolean;
|
|
12067
|
-
/** @description Resources with exclusive access. */
|
|
13079
|
+
/** @description Resources and benefits with exclusive access. */
|
|
12068
13080
|
exclusiveAccess?: {
|
|
13081
|
+
/** @description Benefit IDs with exclusive access. */
|
|
13082
|
+
benefitRefs: string[];
|
|
12069
13083
|
/** @description Resource IDs with exclusive access. */
|
|
12070
13084
|
resourceRefs: string[];
|
|
12071
13085
|
};
|
|
@@ -15464,6 +16478,44 @@ interface components {
|
|
|
15464
16478
|
* @description ISO timestamp of when the visit was created.
|
|
15465
16479
|
*/
|
|
15466
16480
|
createDate: string;
|
|
16481
|
+
/** @description Host customer. */
|
|
16482
|
+
customer: {
|
|
16483
|
+
/** @description Company of the host, present when the host membership is a member of a company. */
|
|
16484
|
+
company?: {
|
|
16485
|
+
/**
|
|
16486
|
+
* Format: uuid
|
|
16487
|
+
* @description Unique identifier of the company.
|
|
16488
|
+
*/
|
|
16489
|
+
id: string;
|
|
16490
|
+
/** @description Company name. */
|
|
16491
|
+
title: string;
|
|
16492
|
+
};
|
|
16493
|
+
/**
|
|
16494
|
+
* Format: uuid
|
|
16495
|
+
* @description ID of the host customer.
|
|
16496
|
+
*/
|
|
16497
|
+
id: string;
|
|
16498
|
+
/** @description Host user details. */
|
|
16499
|
+
user: {
|
|
16500
|
+
/** @description About text of the host user. */
|
|
16501
|
+
about?: string | null;
|
|
16502
|
+
/** @description Email of the host user. */
|
|
16503
|
+
email?: string | null;
|
|
16504
|
+
/**
|
|
16505
|
+
* Format: uuid
|
|
16506
|
+
* @description Unique identifier of the host user.
|
|
16507
|
+
*/
|
|
16508
|
+
id: string;
|
|
16509
|
+
/** @description First name of the host user. */
|
|
16510
|
+
name?: string | null;
|
|
16511
|
+
/** @description Phone number of the host user. */
|
|
16512
|
+
phoneNumber?: string | null;
|
|
16513
|
+
/** @description Profile photo URL of the host user. */
|
|
16514
|
+
photoUrl?: string | null;
|
|
16515
|
+
/** @description Surname of the host user. */
|
|
16516
|
+
surname?: string | null;
|
|
16517
|
+
};
|
|
16518
|
+
};
|
|
15467
16519
|
/**
|
|
15468
16520
|
* Format: date-time
|
|
15469
16521
|
* @description ISO timestamp of the scheduled visit date.
|
|
@@ -15500,10 +16552,14 @@ interface components {
|
|
|
15500
16552
|
locationRef: string;
|
|
15501
16553
|
/**
|
|
15502
16554
|
* Format: uuid
|
|
15503
|
-
* @
|
|
16555
|
+
* @deprecated
|
|
16556
|
+
* @description Deprecated. Use customer.id instead.
|
|
15504
16557
|
*/
|
|
15505
16558
|
membershipRefHost: string;
|
|
15506
|
-
/**
|
|
16559
|
+
/**
|
|
16560
|
+
* @deprecated
|
|
16561
|
+
* @description Deprecated. Use customer.user instead.
|
|
16562
|
+
*/
|
|
15507
16563
|
userHost: {
|
|
15508
16564
|
/** @description About text of the host user. */
|
|
15509
16565
|
about?: string | null;
|
|
@@ -15699,11 +16755,11 @@ interface components {
|
|
|
15699
16755
|
/** @description Display name of the benefit. */
|
|
15700
16756
|
title: string;
|
|
15701
16757
|
/**
|
|
15702
|
-
* @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
|
|
16758
|
+
* @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
|
|
15703
16759
|
* @default public
|
|
15704
16760
|
* @enum {string}
|
|
15705
16761
|
*/
|
|
15706
|
-
visibility?: "public" | "admins" | "members" | "networkMembers";
|
|
16762
|
+
visibility?: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
|
|
15707
16763
|
};
|
|
15708
16764
|
};
|
|
15709
16765
|
};
|
|
@@ -15784,11 +16840,11 @@ interface components {
|
|
|
15784
16840
|
/** @description Display name of the benefit. */
|
|
15785
16841
|
title: string;
|
|
15786
16842
|
/**
|
|
15787
|
-
* @description Who can see this benefit: 'public' (everyone), 'admins', 'members', or 'networkMembers'.
|
|
16843
|
+
* @description Who can see this benefit: 'public' (everyone), 'admins', 'exclusiveMembers', 'members', or 'networkMembers'.
|
|
15788
16844
|
* @default public
|
|
15789
16845
|
* @enum {string}
|
|
15790
16846
|
*/
|
|
15791
|
-
visibility?: "public" | "admins" | "members" | "networkMembers";
|
|
16847
|
+
visibility?: "public" | "admins" | "exclusiveMembers" | "members" | "networkMembers";
|
|
15792
16848
|
};
|
|
15793
16849
|
};
|
|
15794
16850
|
};
|
|
@@ -17148,12 +18204,14 @@ interface components {
|
|
|
17148
18204
|
shop?: number;
|
|
17149
18205
|
};
|
|
17150
18206
|
/**
|
|
17151
|
-
* @description Resources exclusively available to members on this plan.
|
|
18207
|
+
* @description Resources and benefits exclusively available to members on this plan.
|
|
17152
18208
|
* @default {
|
|
17153
18209
|
* "resourceRefs": []
|
|
17154
18210
|
* }
|
|
17155
18211
|
*/
|
|
17156
18212
|
exclusiveAccess?: {
|
|
18213
|
+
/** @description Benefit IDs with exclusive access for this plan. */
|
|
18214
|
+
benefitRefs?: string[];
|
|
17157
18215
|
/** @description Resource IDs with exclusive access for this plan. */
|
|
17158
18216
|
resourceRefs: string[];
|
|
17159
18217
|
};
|
|
@@ -17302,12 +18360,14 @@ interface components {
|
|
|
17302
18360
|
shop: number;
|
|
17303
18361
|
};
|
|
17304
18362
|
/**
|
|
17305
|
-
* @description Resources exclusively available to members on this plan.
|
|
18363
|
+
* @description Resources and benefits exclusively available to members on this plan.
|
|
17306
18364
|
* @default {
|
|
17307
18365
|
* "resourceRefs": []
|
|
17308
18366
|
* }
|
|
17309
18367
|
*/
|
|
17310
18368
|
exclusiveAccess?: {
|
|
18369
|
+
/** @description Benefit IDs with exclusive access for this plan. */
|
|
18370
|
+
benefitRefs?: string[];
|
|
17311
18371
|
/** @description Resource IDs with exclusive access for this plan. */
|
|
17312
18372
|
resourceRefs: string[];
|
|
17313
18373
|
};
|
|
@@ -17387,6 +18447,11 @@ interface components {
|
|
|
17387
18447
|
bookingStepMinutes?: number;
|
|
17388
18448
|
/** @description Brivo access group reference. */
|
|
17389
18449
|
brivoGroupRef?: number | null;
|
|
18450
|
+
/**
|
|
18451
|
+
* @description Buffer time blocked before each booking.
|
|
18452
|
+
* @enum {string}
|
|
18453
|
+
*/
|
|
18454
|
+
bufferTime?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
17390
18455
|
/** @description Maximum capacity per booking. */
|
|
17391
18456
|
capacity?: number | null;
|
|
17392
18457
|
/** @description Check-in settings. */
|
|
@@ -17597,7 +18662,8 @@ interface components {
|
|
|
17597
18662
|
}[];
|
|
17598
18663
|
};
|
|
17599
18664
|
/**
|
|
17600
|
-
* @
|
|
18665
|
+
* @deprecated
|
|
18666
|
+
* @description Deprecated. Use bufferTime instead.
|
|
17601
18667
|
* @enum {string}
|
|
17602
18668
|
*/
|
|
17603
18669
|
preparationMinutes?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
@@ -17729,6 +18795,11 @@ interface components {
|
|
|
17729
18795
|
bookingStepMinutes?: number;
|
|
17730
18796
|
/** @description Brivo access group reference. */
|
|
17731
18797
|
brivoGroupRef?: number | null;
|
|
18798
|
+
/**
|
|
18799
|
+
* @description Buffer time blocked before each booking.
|
|
18800
|
+
* @enum {string}
|
|
18801
|
+
*/
|
|
18802
|
+
bufferTime?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
17732
18803
|
/** @description Maximum capacity per booking. */
|
|
17733
18804
|
capacity?: number | null;
|
|
17734
18805
|
/** @description Check-in settings. */
|
|
@@ -17929,7 +19000,8 @@ interface components {
|
|
|
17929
19000
|
}[];
|
|
17930
19001
|
};
|
|
17931
19002
|
/**
|
|
17932
|
-
* @
|
|
19003
|
+
* @deprecated
|
|
19004
|
+
* @description Deprecated. Use bufferTime instead.
|
|
17933
19005
|
* @enum {string}
|
|
17934
19006
|
*/
|
|
17935
19007
|
preparationMinutes?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
@@ -18039,22 +19111,35 @@ interface components {
|
|
|
18039
19111
|
content: {
|
|
18040
19112
|
"application/json": {
|
|
18041
19113
|
booking: {
|
|
18042
|
-
endDate: components["schemas"]["dateSchema"];
|
|
18043
|
-
memo?: string;
|
|
18044
19114
|
/**
|
|
18045
|
-
* Format:
|
|
18046
|
-
* @description
|
|
19115
|
+
* Format: date-time
|
|
19116
|
+
* @description ISO timestamp when the booking ends.
|
|
18047
19117
|
*/
|
|
18048
|
-
|
|
18049
|
-
|
|
18050
|
-
|
|
19118
|
+
endDate: string;
|
|
19119
|
+
/** @description Set to true to book the entire resource instead of individual seats. Supported for office resources. */
|
|
19120
|
+
entire?: boolean;
|
|
18051
19121
|
/**
|
|
18052
19122
|
* Format: uuid
|
|
18053
|
-
* @
|
|
19123
|
+
* @deprecated
|
|
19124
|
+
* @description Membership id to book on behalf of. Defaults to the authenticated user's membership.
|
|
18054
19125
|
*/
|
|
18055
19126
|
membershipRefOwner?: string;
|
|
19127
|
+
/** @description Internal note attached to the booking. */
|
|
19128
|
+
memo?: string;
|
|
19129
|
+
/**
|
|
19130
|
+
* Format: uuid
|
|
19131
|
+
* @description ID of the resource to book.
|
|
19132
|
+
*/
|
|
19133
|
+
resourceRef: string;
|
|
18056
19134
|
/** @description Number of seats to reserve. Required for desk and office resources. */
|
|
18057
19135
|
seats?: number;
|
|
19136
|
+
/**
|
|
19137
|
+
* Format: date-time
|
|
19138
|
+
* @description ISO timestamp when the booking starts.
|
|
19139
|
+
*/
|
|
19140
|
+
startDate: string;
|
|
19141
|
+
/** @description Custom title for the booking. */
|
|
19142
|
+
title?: string;
|
|
18058
19143
|
};
|
|
18059
19144
|
};
|
|
18060
19145
|
};
|
|
@@ -18459,8 +19544,10 @@ interface components {
|
|
|
18459
19544
|
endDate?: string;
|
|
18460
19545
|
/** @description Whether the item grants access to the entire resource. */
|
|
18461
19546
|
entire?: boolean;
|
|
18462
|
-
/** @description Resources with exclusive access. */
|
|
19547
|
+
/** @description Resources and benefits with exclusive access. */
|
|
18463
19548
|
exclusiveAccess?: {
|
|
19549
|
+
/** @description Benefit IDs with exclusive access. */
|
|
19550
|
+
benefitRefs?: string[];
|
|
18464
19551
|
/** @description Resource IDs with exclusive access. */
|
|
18465
19552
|
resourceRefs?: string[];
|
|
18466
19553
|
};
|
|
@@ -18649,8 +19736,10 @@ interface components {
|
|
|
18649
19736
|
endDate?: string;
|
|
18650
19737
|
/** @description Whether the item grants access to the entire resource. */
|
|
18651
19738
|
entire?: boolean;
|
|
18652
|
-
/** @description Resources with exclusive access. */
|
|
19739
|
+
/** @description Resources and benefits with exclusive access. */
|
|
18653
19740
|
exclusiveAccess?: {
|
|
19741
|
+
/** @description Benefit IDs with exclusive access. */
|
|
19742
|
+
benefitRefs?: string[];
|
|
18654
19743
|
/** @description Resource IDs with exclusive access. */
|
|
18655
19744
|
resourceRefs?: string[];
|
|
18656
19745
|
};
|
|
@@ -18838,8 +19927,10 @@ interface components {
|
|
|
18838
19927
|
endDate?: string;
|
|
18839
19928
|
/** @description Whether the item grants access to the entire resource. */
|
|
18840
19929
|
entire?: boolean;
|
|
18841
|
-
/** @description Resources with exclusive access. */
|
|
19930
|
+
/** @description Resources and benefits with exclusive access. */
|
|
18842
19931
|
exclusiveAccess?: {
|
|
19932
|
+
/** @description Benefit IDs with exclusive access. */
|
|
19933
|
+
benefitRefs?: string[];
|
|
18843
19934
|
/** @description Resource IDs with exclusive access. */
|
|
18844
19935
|
resourceRefs?: string[];
|
|
18845
19936
|
};
|
|
@@ -18986,8 +20077,10 @@ interface components {
|
|
|
18986
20077
|
endDate?: string;
|
|
18987
20078
|
/** @description Whether the item grants access to the entire resource. */
|
|
18988
20079
|
entire?: boolean;
|
|
18989
|
-
/** @description Resources with exclusive access. */
|
|
20080
|
+
/** @description Resources and benefits with exclusive access. */
|
|
18990
20081
|
exclusiveAccess?: {
|
|
20082
|
+
/** @description Benefit IDs with exclusive access. */
|
|
20083
|
+
benefitRefs?: string[];
|
|
18991
20084
|
/** @description Resource IDs with exclusive access. */
|
|
18992
20085
|
resourceRefs?: string[];
|
|
18993
20086
|
};
|
|
@@ -24094,14 +25187,14 @@ interface operations {
|
|
|
24094
25187
|
getResources: {
|
|
24095
25188
|
parameters: {
|
|
24096
25189
|
query: {
|
|
24097
|
-
/** @description
|
|
24098
|
-
locationRef: string;
|
|
24099
|
-
/** @description The types of resources to retrieve. Pass them as comma separated values. */
|
|
24100
|
-
types?: "hotDesk" | "dedicatedDesk" | "office" | "parkingLot" | "room";
|
|
24101
|
-
/** @description Token to retrieve the next page of results. */
|
|
24102
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
24103
|
-
/** @description The number of items to return. */
|
|
25190
|
+
/** @description Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
24104
25191
|
limit?: number;
|
|
25192
|
+
/** @description UUID of the location whose resources to list. */
|
|
25193
|
+
locationRef: string;
|
|
25194
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
25195
|
+
nextPageToken?: string;
|
|
25196
|
+
/** @description Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. Defaults to all bookable types. */
|
|
25197
|
+
types?: string;
|
|
24105
25198
|
};
|
|
24106
25199
|
header?: {
|
|
24107
25200
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -24118,11 +25211,7 @@ interface operations {
|
|
|
24118
25211
|
[name: string]: unknown;
|
|
24119
25212
|
};
|
|
24120
25213
|
content: {
|
|
24121
|
-
"application/json":
|
|
24122
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
24123
|
-
resources?: components["schemas"]["resource"][];
|
|
24124
|
-
searchQueryNext?: components["schemas"]["searchQueryNext"];
|
|
24125
|
-
};
|
|
25214
|
+
"application/json": components["schemas"]["getResources"];
|
|
24126
25215
|
};
|
|
24127
25216
|
};
|
|
24128
25217
|
/** @description Bad Request */
|
|
@@ -24154,9 +25243,7 @@ interface operations {
|
|
|
24154
25243
|
[name: string]: unknown;
|
|
24155
25244
|
};
|
|
24156
25245
|
content: {
|
|
24157
|
-
"application/json":
|
|
24158
|
-
resource?: components["schemas"]["resource"];
|
|
24159
|
-
};
|
|
25246
|
+
"application/json": components["schemas"]["getResource"];
|
|
24160
25247
|
};
|
|
24161
25248
|
};
|
|
24162
25249
|
/** @description Bad Request */
|
|
@@ -24244,10 +25331,13 @@ interface operations {
|
|
|
24244
25331
|
getResource: {
|
|
24245
25332
|
parameters: {
|
|
24246
25333
|
query?: never;
|
|
24247
|
-
header?:
|
|
25334
|
+
header?: {
|
|
25335
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25336
|
+
"spacebring-network-id"?: string;
|
|
25337
|
+
};
|
|
24248
25338
|
path: {
|
|
24249
25339
|
/** @description The id of the resource. */
|
|
24250
|
-
|
|
25340
|
+
resourceId: string;
|
|
24251
25341
|
};
|
|
24252
25342
|
cookie?: never;
|
|
24253
25343
|
};
|
|
@@ -24259,9 +25349,7 @@ interface operations {
|
|
|
24259
25349
|
[name: string]: unknown;
|
|
24260
25350
|
};
|
|
24261
25351
|
content: {
|
|
24262
|
-
"application/json":
|
|
24263
|
-
resource?: components["schemas"]["resource"];
|
|
24264
|
-
};
|
|
25352
|
+
"application/json": components["schemas"]["getResource"];
|
|
24265
25353
|
};
|
|
24266
25354
|
};
|
|
24267
25355
|
/** @description Bad Request */
|
|
@@ -24278,10 +25366,13 @@ interface operations {
|
|
|
24278
25366
|
patchResource: {
|
|
24279
25367
|
parameters: {
|
|
24280
25368
|
query?: never;
|
|
24281
|
-
header?:
|
|
25369
|
+
header?: {
|
|
25370
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25371
|
+
"spacebring-network-id"?: string;
|
|
25372
|
+
};
|
|
24282
25373
|
path: {
|
|
24283
25374
|
/** @description The id of the resource. */
|
|
24284
|
-
|
|
25375
|
+
resourceId: string;
|
|
24285
25376
|
};
|
|
24286
25377
|
cookie?: never;
|
|
24287
25378
|
};
|
|
@@ -24308,66 +25399,50 @@ interface operations {
|
|
|
24308
25399
|
getBookings: {
|
|
24309
25400
|
parameters: {
|
|
24310
25401
|
query?: {
|
|
24311
|
-
/** @description
|
|
24312
|
-
|
|
24313
|
-
/** @description
|
|
25402
|
+
/** @description Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
25403
|
+
"endDate[gt]"?: string;
|
|
25404
|
+
/** @description Matches bookings with endDate on or after this date (ISO 8601). */
|
|
25405
|
+
"endDate[gte]"?: string;
|
|
25406
|
+
/** @description Matches bookings with endDate strictly before this date (ISO 8601). */
|
|
25407
|
+
"endDate[lt]"?: string;
|
|
25408
|
+
/** @description Matches bookings with endDate on or before this date (ISO 8601). */
|
|
25409
|
+
"endDate[lte]"?: string;
|
|
25410
|
+
/** @description Matches bookings with startDate strictly after this date (ISO 8601). */
|
|
25411
|
+
"startDate[gt]"?: string;
|
|
25412
|
+
/** @description Matches bookings with startDate on or after this date (ISO 8601). */
|
|
25413
|
+
"startDate[gte]"?: string;
|
|
25414
|
+
/** @description Matches bookings with startDate strictly before this date (ISO 8601). */
|
|
25415
|
+
"startDate[lt]"?: string;
|
|
25416
|
+
/** @description Matches bookings with startDate on or before this date (ISO 8601). */
|
|
25417
|
+
"startDate[lte]"?: string;
|
|
25418
|
+
/** @description UUID of the customer whose bookings to list. */
|
|
25419
|
+
customerRef?: string;
|
|
25420
|
+
/** @description Deprecated. Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
25421
|
+
endDate?: string;
|
|
25422
|
+
/** @description Deprecated. Use status "canceled" instead. Set to "true" to include deleted bookings. */
|
|
25423
|
+
includeDeleted?: string;
|
|
25424
|
+
/** @description Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
25425
|
+
limit?: number;
|
|
25426
|
+
/** @description UUID of the location whose bookings to list. Required when resourceRef is omitted. */
|
|
24314
25427
|
locationRef?: string;
|
|
24315
|
-
/** @description
|
|
25428
|
+
/** @description Deprecated. Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
24316
25429
|
membershipRefOwner?: string;
|
|
24317
|
-
/** @description
|
|
24318
|
-
|
|
24319
|
-
|
|
24320
|
-
* Format: date-time
|
|
24321
|
-
* @description Get bookings with less or equal end date. Example: endDate[lte]=2021-05-21T10:00:00Z
|
|
24322
|
-
*/
|
|
24323
|
-
lte?: string;
|
|
24324
|
-
/**
|
|
24325
|
-
* Format: date-time
|
|
24326
|
-
* @description Get bookings with greater or equal end date. Example: endDate[gte]=2021-05-21T10:00:00Z
|
|
24327
|
-
*/
|
|
24328
|
-
gte?: string;
|
|
24329
|
-
/**
|
|
24330
|
-
* Format: date-time
|
|
24331
|
-
* @description Get bookings with less end date. Example: endDate[lt]=2021-05-21T10:00:00Z
|
|
24332
|
-
*/
|
|
24333
|
-
lt?: string;
|
|
24334
|
-
/**
|
|
24335
|
-
* Format: date-time
|
|
24336
|
-
* @description Get bookings with greater end date. Example: endDate[gt]=2021-05-21T10:00:00Z
|
|
24337
|
-
*/
|
|
24338
|
-
gt?: string;
|
|
24339
|
-
};
|
|
24340
|
-
/** @description The date filter of items. */
|
|
24341
|
-
startDate?: {
|
|
24342
|
-
/**
|
|
24343
|
-
* Format: date-time
|
|
24344
|
-
* @description Get bookings with less or equal start date. Example: startDate[lte]=2021-05-21T10:00:00Z
|
|
24345
|
-
*/
|
|
24346
|
-
lte?: string;
|
|
24347
|
-
/**
|
|
24348
|
-
* Format: date-time
|
|
24349
|
-
* @description Get bookings with greater or equal start date. Example: startDate[gte]=2021-05-21T10:00:00Z
|
|
24350
|
-
*/
|
|
24351
|
-
gte?: string;
|
|
24352
|
-
/**
|
|
24353
|
-
* Format: date-time
|
|
24354
|
-
* @description Get bookings with less start date. Example: startDate[lt]=2021-05-21T10:00:00Z
|
|
24355
|
-
*/
|
|
24356
|
-
lt?: string;
|
|
24357
|
-
/**
|
|
24358
|
-
* Format: date-time
|
|
24359
|
-
* @description Get bookings with greater start date. Example: startDate[gt]=2021-05-21T10:00:00Z
|
|
24360
|
-
*/
|
|
24361
|
-
gt?: string;
|
|
24362
|
-
};
|
|
24363
|
-
/** @description The number of items to return */
|
|
24364
|
-
limit?: number;
|
|
24365
|
-
/** @description The order of filtered items. Format - `field:order`. Possible field values are `createDate`, `endDate`, `startDate`, `id`. Order values - `asc`, `desc`. */
|
|
25430
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
25431
|
+
nextPageToken?: string;
|
|
25432
|
+
/** @description Sort order as `<field>:<direction>`, where field is startDate, endDate or createDate and direction is asc or desc. */
|
|
24366
25433
|
order?: string;
|
|
24367
|
-
/** @description
|
|
24368
|
-
|
|
24369
|
-
/** @description
|
|
24370
|
-
|
|
25434
|
+
/** @description UUID of the resource whose bookings to list. Required when locationRef is omitted. */
|
|
25435
|
+
resourceRef?: string;
|
|
25436
|
+
/** @description Set to "true" to expand repeating bookings into single occurrences. */
|
|
25437
|
+
singleBookings?: string;
|
|
25438
|
+
/** @description Deprecated. Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
25439
|
+
startDate?: string;
|
|
25440
|
+
/** @description Comma-separated list of booking statuses to filter by, e.g. `confirmed,canceled`. Valid values: tentative, confirmed, canceled. Defaults to tentative, confirmed. */
|
|
25441
|
+
status?: string;
|
|
25442
|
+
/** @description Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. Defaults to all bookable types. */
|
|
25443
|
+
type?: string;
|
|
25444
|
+
/** @description Deprecated. Use type instead. */
|
|
25445
|
+
types?: string;
|
|
24371
25446
|
};
|
|
24372
25447
|
header?: {
|
|
24373
25448
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -24384,11 +25459,7 @@ interface operations {
|
|
|
24384
25459
|
[name: string]: unknown;
|
|
24385
25460
|
};
|
|
24386
25461
|
content: {
|
|
24387
|
-
"application/json":
|
|
24388
|
-
bookings?: components["schemas"]["booking"][];
|
|
24389
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
24390
|
-
searchQueryNext?: components["schemas"]["searchQueryNext"];
|
|
24391
|
-
};
|
|
25462
|
+
"application/json": components["schemas"]["getBookings"];
|
|
24392
25463
|
};
|
|
24393
25464
|
};
|
|
24394
25465
|
/** @description Bad Request */
|
|
@@ -24420,9 +25491,7 @@ interface operations {
|
|
|
24420
25491
|
[name: string]: unknown;
|
|
24421
25492
|
};
|
|
24422
25493
|
content: {
|
|
24423
|
-
"application/json":
|
|
24424
|
-
booking?: components["schemas"]["booking"];
|
|
24425
|
-
};
|
|
25494
|
+
"application/json": components["schemas"]["getBooking"];
|
|
24426
25495
|
};
|
|
24427
25496
|
};
|
|
24428
25497
|
/** @description Bad Request */
|
|
@@ -24444,8 +25513,8 @@ interface operations {
|
|
|
24444
25513
|
"spacebring-network-id"?: string;
|
|
24445
25514
|
};
|
|
24446
25515
|
path: {
|
|
24447
|
-
/** @description
|
|
24448
|
-
|
|
25516
|
+
/** @description ID of the booking. For a single occurrence of a repeating booking, append the occurrence date: `<bookingId>_<ISO date>`. */
|
|
25517
|
+
bookingId: string;
|
|
24449
25518
|
};
|
|
24450
25519
|
cookie?: never;
|
|
24451
25520
|
};
|
|
@@ -24457,9 +25526,7 @@ interface operations {
|
|
|
24457
25526
|
[name: string]: unknown;
|
|
24458
25527
|
};
|
|
24459
25528
|
content: {
|
|
24460
|
-
"application/json":
|
|
24461
|
-
booking?: components["schemas"]["booking"];
|
|
24462
|
-
};
|
|
25529
|
+
"application/json": components["schemas"]["getBooking"];
|
|
24463
25530
|
};
|
|
24464
25531
|
};
|
|
24465
25532
|
/** @description Bad Request */
|
|
@@ -24481,8 +25548,8 @@ interface operations {
|
|
|
24481
25548
|
"spacebring-network-id"?: string;
|
|
24482
25549
|
};
|
|
24483
25550
|
path: {
|
|
24484
|
-
/** @description
|
|
24485
|
-
|
|
25551
|
+
/** @description ID of the booking. For a single occurrence of a repeating booking, append the occurrence date: `<bookingId>_<ISO date>`. */
|
|
25552
|
+
bookingId: string;
|
|
24486
25553
|
};
|
|
24487
25554
|
cookie?: never;
|
|
24488
25555
|
};
|
|
@@ -26943,9 +28010,9 @@ type UpdateShopCategoryBody = NonNullable<NonNullable<operations["updateShopCate
|
|
|
26943
28010
|
/** A Assignment entity as returned by the Spacebring API. */
|
|
26944
28011
|
type Assignment = NonNullable<operations["getAssignments"]["responses"][200]["content"]["application/json"]["assignments"]>[number];
|
|
26945
28012
|
/** A Booking entity as returned by the Spacebring API. */
|
|
26946
|
-
type Booking = NonNullable<
|
|
28013
|
+
type Booking = NonNullable<operations["getBooking"]["responses"][200]["content"]["application/json"]["booking"]>;
|
|
26947
28014
|
/** A Resource entity as returned by the Spacebring API. */
|
|
26948
|
-
type Resource = NonNullable<
|
|
28015
|
+
type Resource = NonNullable<operations["getResource"]["responses"][200]["content"]["application/json"]["resource"]>;
|
|
26949
28016
|
/** Query parameters for `sb.resources.getAssignments()`. */
|
|
26950
28017
|
interface GetAssignmentsQuery {
|
|
26951
28018
|
/** UUID of the location whose resource assignments to list. */
|
|
@@ -26953,45 +28020,61 @@ interface GetAssignmentsQuery {
|
|
|
26953
28020
|
}
|
|
26954
28021
|
/** Query parameters for `sb.resources.bookings.list()`. */
|
|
26955
28022
|
interface GetBookingsQuery {
|
|
26956
|
-
/**
|
|
26957
|
-
|
|
26958
|
-
/**
|
|
28023
|
+
/** Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
28024
|
+
"endDate[gt]"?: string;
|
|
28025
|
+
/** Matches bookings with endDate on or after this date (ISO 8601). */
|
|
28026
|
+
"endDate[gte]"?: string;
|
|
28027
|
+
/** Matches bookings with endDate strictly before this date (ISO 8601). */
|
|
28028
|
+
"endDate[lt]"?: string;
|
|
28029
|
+
/** Matches bookings with endDate on or before this date (ISO 8601). */
|
|
28030
|
+
"endDate[lte]"?: string;
|
|
28031
|
+
/** Matches bookings with startDate strictly after this date (ISO 8601). */
|
|
28032
|
+
"startDate[gt]"?: string;
|
|
28033
|
+
/** Matches bookings with startDate on or after this date (ISO 8601). */
|
|
28034
|
+
"startDate[gte]"?: string;
|
|
28035
|
+
/** Matches bookings with startDate strictly before this date (ISO 8601). */
|
|
28036
|
+
"startDate[lt]"?: string;
|
|
28037
|
+
/** Matches bookings with startDate on or before this date (ISO 8601). */
|
|
28038
|
+
"startDate[lte]"?: string;
|
|
28039
|
+
/** UUID of the customer whose bookings to list. */
|
|
28040
|
+
customerRef?: string;
|
|
28041
|
+
/** @deprecated Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
28042
|
+
endDate?: string;
|
|
28043
|
+
/** @deprecated Use status "canceled" instead. Set to "true" to include deleted bookings. */
|
|
28044
|
+
includeDeleted?: string;
|
|
28045
|
+
/** Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28046
|
+
limit?: number;
|
|
28047
|
+
/** UUID of the location whose bookings to list. Required when resourceRef is omitted. */
|
|
26959
28048
|
locationRef?: string;
|
|
26960
|
-
/**
|
|
28049
|
+
/** @deprecated Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
26961
28050
|
membershipRefOwner?: string;
|
|
26962
|
-
/**
|
|
26963
|
-
endDate?: {
|
|
26964
|
-
lte?: string;
|
|
26965
|
-
gte?: string;
|
|
26966
|
-
lt?: string;
|
|
26967
|
-
gt?: string;
|
|
26968
|
-
};
|
|
26969
|
-
/** The date filter of items. */
|
|
26970
|
-
startDate?: {
|
|
26971
|
-
lte?: string;
|
|
26972
|
-
gte?: string;
|
|
26973
|
-
lt?: string;
|
|
26974
|
-
gt?: string;
|
|
26975
|
-
};
|
|
26976
|
-
/** The number of items to return */
|
|
26977
|
-
limit?: number;
|
|
26978
|
-
/** The order of filtered items. Format - `field:order`. Possible field values are `createDate`, `endDate`, `startDate`, `id`. Order values - `asc`, `desc`. */
|
|
26979
|
-
order?: string;
|
|
26980
|
-
/** Token to retrieve the next page of results. */
|
|
28051
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
26981
28052
|
nextPageToken?: string;
|
|
26982
|
-
/**
|
|
26983
|
-
|
|
28053
|
+
/** Sort order as `:`, where field is startDate, endDate or createDate and direction is asc or desc. */
|
|
28054
|
+
order?: string;
|
|
28055
|
+
/** UUID of the resource whose bookings to list. Required when locationRef is omitted. */
|
|
28056
|
+
resourceRef?: string;
|
|
28057
|
+
/** Set to "true" to expand repeating bookings into single occurrences. */
|
|
28058
|
+
singleBookings?: string;
|
|
28059
|
+
/** @deprecated Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
28060
|
+
startDate?: string;
|
|
28061
|
+
/** Comma-separated list of booking statuses to filter by, e.g. `confirmed,canceled`. Valid values: tentative, confirmed, canceled. Defaults to tentative, confirmed. */
|
|
28062
|
+
status?: string;
|
|
28063
|
+
/** Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. Defaults to all bookable types. */
|
|
28064
|
+
type?: string;
|
|
28065
|
+
/** @deprecated Use type instead. */
|
|
28066
|
+
types?: string;
|
|
26984
28067
|
}
|
|
26985
28068
|
/** Query parameters for `sb.resources.list()`. */
|
|
26986
28069
|
interface GetResourcesQuery {
|
|
26987
|
-
/**
|
|
28070
|
+
/** Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28071
|
+
limit?: number;
|
|
28072
|
+
/** UUID of the location whose resources to list. */
|
|
26988
28073
|
locationRef: string;
|
|
26989
|
-
/**
|
|
26990
|
-
types?: "hotDesk" | "dedicatedDesk" | "office" | "parkingLot" | "room";
|
|
26991
|
-
/** Token to retrieve the next page of results. */
|
|
28074
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
26992
28075
|
nextPageToken?: string;
|
|
26993
|
-
/**
|
|
26994
|
-
|
|
28076
|
+
/** Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. Defaults to all bookable types. */
|
|
28077
|
+
types?: string;
|
|
26995
28078
|
}
|
|
26996
28079
|
/** Request body for `sb.resources.bookings.create()`. */
|
|
26997
28080
|
type CreateBookingBody = NonNullable<NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"]["booking"]>;
|
|
@@ -27782,24 +28865,24 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
27782
28865
|
resources: {
|
|
27783
28866
|
list(query: GetResourcesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27784
28867
|
nextPageToken?: string;
|
|
27785
|
-
resources
|
|
28868
|
+
resources: Resource[];
|
|
27786
28869
|
searchQueryNext?: string;
|
|
27787
28870
|
}>;
|
|
27788
28871
|
iterate(query: Omit<GetResourcesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Resource, void, undefined>;
|
|
27789
|
-
get(
|
|
28872
|
+
get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
27790
28873
|
create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
27791
|
-
update(
|
|
28874
|
+
update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
27792
28875
|
getAssignments(query: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<Assignment[]>;
|
|
27793
28876
|
bookings: {
|
|
27794
28877
|
list(query?: GetBookingsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27795
|
-
bookings
|
|
28878
|
+
bookings: Booking[];
|
|
27796
28879
|
nextPageToken?: string;
|
|
27797
28880
|
searchQueryNext?: string;
|
|
27798
28881
|
}>;
|
|
27799
28882
|
iterate(query?: Omit<GetBookingsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Booking, void, undefined>;
|
|
27800
|
-
get(
|
|
28883
|
+
get(bookingId: string, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
27801
28884
|
create(booking: CreateBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
27802
|
-
delete(
|
|
28885
|
+
delete(bookingId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
27803
28886
|
};
|
|
27804
28887
|
};
|
|
27805
28888
|
shop: {
|