@izak0s/spacebring-api 5.6.0 → 6.1.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 +1739 -648
- package/dist/index.d.ts +1739 -648
- 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;
|
|
@@ -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.
|
|
@@ -8010,6 +8004,8 @@ interface components {
|
|
|
8010
8004
|
* @description Tapkey access group reference.
|
|
8011
8005
|
*/
|
|
8012
8006
|
tapkeyGroupRef?: string;
|
|
8007
|
+
/** @description UniFi Access policy reference. */
|
|
8008
|
+
unifiAccessGroupRef?: string;
|
|
8013
8009
|
};
|
|
8014
8010
|
/**
|
|
8015
8011
|
* @description Addons included in the plan.
|
|
@@ -8181,6 +8177,8 @@ interface components {
|
|
|
8181
8177
|
* @description Tapkey access group reference.
|
|
8182
8178
|
*/
|
|
8183
8179
|
tapkeyGroupRef?: string;
|
|
8180
|
+
/** @description UniFi Access policy reference. */
|
|
8181
|
+
unifiAccessGroupRef?: string;
|
|
8184
8182
|
};
|
|
8185
8183
|
/**
|
|
8186
8184
|
* @description Addons included in the plan.
|
|
@@ -8351,6 +8349,8 @@ interface components {
|
|
|
8351
8349
|
* @description Tapkey access group reference.
|
|
8352
8350
|
*/
|
|
8353
8351
|
tapkeyGroupRef?: string;
|
|
8352
|
+
/** @description UniFi Access policy reference. */
|
|
8353
|
+
unifiAccessGroupRef?: string;
|
|
8354
8354
|
};
|
|
8355
8355
|
/**
|
|
8356
8356
|
* @description Addons included in the plan.
|
|
@@ -8599,334 +8599,293 @@ interface components {
|
|
|
8599
8599
|
surname?: string | null;
|
|
8600
8600
|
};
|
|
8601
8601
|
};
|
|
8602
|
-
|
|
8603
|
-
/** @description
|
|
8604
|
-
|
|
8605
|
-
|
|
8606
|
-
|
|
8602
|
+
getResources: {
|
|
8603
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
8604
|
+
nextPageToken?: string;
|
|
8605
|
+
/** @description List of resources. */
|
|
8606
|
+
resources: {
|
|
8607
|
+
/** @description Active resource assignments. */
|
|
8608
|
+
assignments: {
|
|
8609
|
+
/**
|
|
8610
|
+
* @deprecated
|
|
8611
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
8612
|
+
*/
|
|
8613
|
+
company?: {
|
|
8614
|
+
/**
|
|
8615
|
+
* Format: uuid
|
|
8616
|
+
* @description Company id.
|
|
8617
|
+
*/
|
|
8618
|
+
id: string;
|
|
8619
|
+
/** @description Company name. */
|
|
8620
|
+
title: string;
|
|
8621
|
+
};
|
|
8622
|
+
/** @description Customer the resource is assigned to. */
|
|
8623
|
+
customer?: {
|
|
8624
|
+
/**
|
|
8625
|
+
* Format: uuid
|
|
8626
|
+
* @description Customer id.
|
|
8627
|
+
*/
|
|
8628
|
+
id: string;
|
|
8629
|
+
/** @description Company name when the customer is a company. */
|
|
8630
|
+
title?: string;
|
|
8631
|
+
/**
|
|
8632
|
+
* @description Whether the customer is a user or company.
|
|
8633
|
+
* @enum {string}
|
|
8634
|
+
*/
|
|
8635
|
+
type: "user" | "company";
|
|
8636
|
+
/** @description User details when the customer is a user. */
|
|
8637
|
+
user?: {
|
|
8638
|
+
/** @description User email. */
|
|
8639
|
+
email?: string | null;
|
|
8640
|
+
/**
|
|
8641
|
+
* Format: uuid
|
|
8642
|
+
* @description User id.
|
|
8643
|
+
*/
|
|
8644
|
+
id: string;
|
|
8645
|
+
/** @description User first name. */
|
|
8646
|
+
name?: string | null;
|
|
8647
|
+
/** @description User last name. */
|
|
8648
|
+
surname?: string | null;
|
|
8649
|
+
};
|
|
8650
|
+
};
|
|
8651
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
8652
|
+
entire: boolean;
|
|
8607
8653
|
/**
|
|
8608
8654
|
* Format: uuid
|
|
8609
|
-
* @description
|
|
8655
|
+
* @description Assignment id.
|
|
8610
8656
|
*/
|
|
8611
|
-
id
|
|
8612
|
-
/**
|
|
8613
|
-
|
|
8614
|
-
|
|
8615
|
-
|
|
8616
|
-
|
|
8617
|
-
|
|
8618
|
-
|
|
8619
|
-
|
|
8620
|
-
|
|
8621
|
-
|
|
8622
|
-
|
|
8623
|
-
|
|
8657
|
+
id?: string;
|
|
8658
|
+
/**
|
|
8659
|
+
* @deprecated
|
|
8660
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
8661
|
+
*/
|
|
8662
|
+
membership?: {
|
|
8663
|
+
/**
|
|
8664
|
+
* Format: uuid
|
|
8665
|
+
* @description Membership id.
|
|
8666
|
+
*/
|
|
8667
|
+
id: string;
|
|
8668
|
+
};
|
|
8669
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
8670
|
+
quantity?: number;
|
|
8624
8671
|
/**
|
|
8625
8672
|
* Format: uuid
|
|
8626
|
-
* @description
|
|
8673
|
+
* @description UUID of the resource the assignment belongs to.
|
|
8627
8674
|
*/
|
|
8628
|
-
|
|
8675
|
+
resourceRef: string;
|
|
8676
|
+
/** @description Subscription backing this assignment. */
|
|
8677
|
+
subscription: {
|
|
8678
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
8679
|
+
endDate?: string;
|
|
8680
|
+
/**
|
|
8681
|
+
* Format: uuid
|
|
8682
|
+
* @description Subscription id.
|
|
8683
|
+
*/
|
|
8684
|
+
id: string;
|
|
8685
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
8686
|
+
startDate: string;
|
|
8687
|
+
};
|
|
8688
|
+
/**
|
|
8689
|
+
* @deprecated
|
|
8690
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
8691
|
+
*/
|
|
8692
|
+
user?: {
|
|
8693
|
+
/** @description User email. */
|
|
8694
|
+
email?: string | null;
|
|
8695
|
+
/**
|
|
8696
|
+
* Format: uuid
|
|
8697
|
+
* @description User id.
|
|
8698
|
+
*/
|
|
8699
|
+
id: string;
|
|
8700
|
+
/** @description User first name. */
|
|
8701
|
+
name?: string | null;
|
|
8702
|
+
/** @description User last name. */
|
|
8703
|
+
surname?: string | null;
|
|
8704
|
+
};
|
|
8705
|
+
}[];
|
|
8706
|
+
/** @description Auto-release settings for no-show bookings. */
|
|
8707
|
+
autoRelease?: {
|
|
8708
|
+
/** @description Whether auto-release is enabled. */
|
|
8709
|
+
enabled: boolean;
|
|
8710
|
+
/**
|
|
8711
|
+
* @description Minutes after start or creation before the slot is released.
|
|
8712
|
+
* @enum {string}
|
|
8713
|
+
*/
|
|
8714
|
+
interval: "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
8629
8715
|
};
|
|
8630
|
-
/** @description
|
|
8631
|
-
|
|
8716
|
+
/** @description Avigilon Alta access group reference. */
|
|
8717
|
+
avigilonAltaGroupRef?: number | null;
|
|
8632
8718
|
/**
|
|
8633
|
-
*
|
|
8634
|
-
* @
|
|
8719
|
+
* @description Who can create bookings on this resource.
|
|
8720
|
+
* @enum {string}
|
|
8635
8721
|
*/
|
|
8636
|
-
|
|
8637
|
-
/** @description
|
|
8638
|
-
|
|
8639
|
-
|
|
8640
|
-
|
|
8722
|
+
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
8723
|
+
/** @description Booking step size in minutes. */
|
|
8724
|
+
bookingStepMinutes?: number;
|
|
8725
|
+
/** @description Brivo access group reference. */
|
|
8726
|
+
brivoGroupRef?: number | null;
|
|
8727
|
+
/**
|
|
8728
|
+
* @description Buffer time blocked before each booking.
|
|
8729
|
+
* @enum {string}
|
|
8730
|
+
*/
|
|
8731
|
+
bufferTime: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
8732
|
+
/** @description Maximum capacity per booking. */
|
|
8733
|
+
capacity?: number | null;
|
|
8734
|
+
/** @description Check-in settings. */
|
|
8735
|
+
checkIn?: {
|
|
8641
8736
|
/**
|
|
8642
|
-
*
|
|
8643
|
-
* @
|
|
8737
|
+
* @description How early before start the guest must check in.
|
|
8738
|
+
* @enum {string}
|
|
8644
8739
|
*/
|
|
8645
|
-
|
|
8646
|
-
/** @description ISO timestamp when the assignment starts. */
|
|
8647
|
-
startDate: string;
|
|
8740
|
+
interval: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
8648
8741
|
};
|
|
8649
|
-
/** @description
|
|
8650
|
-
|
|
8651
|
-
/** @description User email. */
|
|
8652
|
-
email?: string | null;
|
|
8742
|
+
/** @description Child resources when this is a parent resource. Bookings on a child resource also block the parent. */
|
|
8743
|
+
children: {
|
|
8653
8744
|
/**
|
|
8654
8745
|
* Format: uuid
|
|
8655
|
-
* @description
|
|
8746
|
+
* @description Id of the child resource.
|
|
8656
8747
|
*/
|
|
8657
8748
|
id: string;
|
|
8658
|
-
/** @description
|
|
8659
|
-
|
|
8660
|
-
|
|
8661
|
-
|
|
8749
|
+
/** @description Title of the child resource. */
|
|
8750
|
+
title: string;
|
|
8751
|
+
}[];
|
|
8752
|
+
/** @description Confirmation email settings. */
|
|
8753
|
+
confirmationEmail: {
|
|
8754
|
+
/** @description Send confirmation when an admin creates a booking. */
|
|
8755
|
+
bookingCreatedByAdmin: boolean;
|
|
8756
|
+
/** @description Send confirmation when a member creates a booking. */
|
|
8757
|
+
bookingCreatedByMember: boolean;
|
|
8758
|
+
/** @description Send confirmation when a network member creates a booking. */
|
|
8759
|
+
bookingCreatedByNetworkMember: boolean;
|
|
8760
|
+
/** @description Send confirmation when a public user creates a booking. */
|
|
8761
|
+
bookingCreatedByPublic: boolean;
|
|
8762
|
+
/** @description Email template id for confirmation emails. */
|
|
8763
|
+
template: string;
|
|
8662
8764
|
};
|
|
8663
|
-
}[];
|
|
8664
|
-
/** @description Auto-release settings for no-show bookings. */
|
|
8665
|
-
autoRelease?: {
|
|
8666
|
-
/** @description Whether auto-release is enabled. */
|
|
8667
|
-
enabled: boolean;
|
|
8668
8765
|
/**
|
|
8669
|
-
*
|
|
8670
|
-
* @
|
|
8671
|
-
*/
|
|
8672
|
-
interval: "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
8673
|
-
};
|
|
8674
|
-
/** @description Avigilon Alta access group reference. */
|
|
8675
|
-
avigilonAltaGroupRef?: number | null;
|
|
8676
|
-
/**
|
|
8677
|
-
* @description Who can create bookings on this resource.
|
|
8678
|
-
* @enum {string}
|
|
8679
|
-
*/
|
|
8680
|
-
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
8681
|
-
/** @description Booking step size in minutes. */
|
|
8682
|
-
bookingStepMinutes?: number;
|
|
8683
|
-
/** @description Brivo access group reference. */
|
|
8684
|
-
brivoGroupRef?: number | null;
|
|
8685
|
-
/** @description Maximum capacity per booking. */
|
|
8686
|
-
capacity?: number | null;
|
|
8687
|
-
/** @description Check-in settings. */
|
|
8688
|
-
checkIn?: {
|
|
8689
|
-
/**
|
|
8690
|
-
* @description How early before start the guest must check in.
|
|
8691
|
-
* @enum {string}
|
|
8766
|
+
* Format: date-time
|
|
8767
|
+
* @description ISO timestamp of when the resource was created.
|
|
8692
8768
|
*/
|
|
8693
|
-
|
|
8694
|
-
|
|
8695
|
-
|
|
8696
|
-
|
|
8769
|
+
createDate: string;
|
|
8770
|
+
/** @description Credit pricing settings. */
|
|
8771
|
+
credits: {
|
|
8772
|
+
/** @description Whether customers can pay with location credits. */
|
|
8773
|
+
enabled: boolean;
|
|
8774
|
+
/** @description Stepped credit pricing tiers. */
|
|
8775
|
+
tiers: {
|
|
8776
|
+
/** @description Fixed fee added for this tier. */
|
|
8777
|
+
flatAmount: number;
|
|
8778
|
+
/** @description Start of this price tier in booking minutes. */
|
|
8779
|
+
from: number;
|
|
8780
|
+
/** @description Variable price per unit within this tier. */
|
|
8781
|
+
unitAmount: number;
|
|
8782
|
+
}[];
|
|
8783
|
+
};
|
|
8784
|
+
/** @description Whether day passes are enabled. */
|
|
8785
|
+
dayPassesEnabled?: boolean;
|
|
8786
|
+
/** @description Description of the resource. */
|
|
8787
|
+
description: string;
|
|
8788
|
+
/** @description Booking duration bounds. */
|
|
8789
|
+
duration: {
|
|
8790
|
+
/** @description Maximum booking duration in minutes. */
|
|
8791
|
+
max: number;
|
|
8792
|
+
/** @description Minimum booking duration in minutes. */
|
|
8793
|
+
min: number;
|
|
8794
|
+
/** @description Duration limits for public bookers. */
|
|
8795
|
+
public: {
|
|
8796
|
+
/** @description Whether public bookers have separate duration limits. */
|
|
8797
|
+
enabled: boolean;
|
|
8798
|
+
/** @description Maximum booking duration in minutes for public bookers. */
|
|
8799
|
+
max: number;
|
|
8800
|
+
/** @description Minimum booking duration in minutes for public bookers. */
|
|
8801
|
+
min: number;
|
|
8802
|
+
};
|
|
8803
|
+
};
|
|
8804
|
+
/** @description Dynamic pricing settings. */
|
|
8805
|
+
dynamicPricing: {
|
|
8806
|
+
/** @description Maximum price increase percentage when demand is high. */
|
|
8807
|
+
deltaAbove: number;
|
|
8808
|
+
/** @description Maximum price decrease percentage when demand is low. */
|
|
8809
|
+
deltaBelow: number;
|
|
8810
|
+
/** @description Whether dynamic pricing is enabled. */
|
|
8811
|
+
enabled: boolean;
|
|
8812
|
+
};
|
|
8813
|
+
/** @description Google Calendar integration settings. */
|
|
8814
|
+
googleCalendar?: {
|
|
8815
|
+
/** @description Google Calendar id. */
|
|
8816
|
+
id: string;
|
|
8817
|
+
/** @description Whether two-way sync is enabled. */
|
|
8818
|
+
twoWaySyncEnabled: boolean;
|
|
8819
|
+
};
|
|
8697
8820
|
/**
|
|
8698
8821
|
* Format: uuid
|
|
8699
|
-
* @description
|
|
8822
|
+
* @description Unique identifier of the resource.
|
|
8700
8823
|
*/
|
|
8701
8824
|
id: string;
|
|
8702
|
-
/** @description
|
|
8703
|
-
|
|
8704
|
-
|
|
8705
|
-
|
|
8706
|
-
|
|
8707
|
-
|
|
8708
|
-
|
|
8709
|
-
|
|
8710
|
-
|
|
8711
|
-
|
|
8712
|
-
|
|
8713
|
-
/** @description
|
|
8714
|
-
|
|
8715
|
-
|
|
8716
|
-
|
|
8717
|
-
|
|
8718
|
-
|
|
8719
|
-
* Format: date-time
|
|
8720
|
-
* @description ISO timestamp of when the resource was created.
|
|
8721
|
-
*/
|
|
8722
|
-
createDate: string;
|
|
8723
|
-
/** @description Credit pricing settings. */
|
|
8724
|
-
credits: {
|
|
8725
|
-
/** @description Whether customers can pay with location credits. */
|
|
8726
|
-
enabled: boolean;
|
|
8727
|
-
/** @description Stepped credit pricing tiers. */
|
|
8728
|
-
tiers: {
|
|
8729
|
-
/** @description Fixed fee added for this tier. */
|
|
8730
|
-
flatAmount: number;
|
|
8731
|
-
/** @description Start of this price tier in booking minutes. */
|
|
8732
|
-
from: number;
|
|
8733
|
-
/** @description Variable price per unit within this tier. */
|
|
8734
|
-
unitAmount: number;
|
|
8825
|
+
/** @description Public URL of the resource image. */
|
|
8826
|
+
imageUrl?: string;
|
|
8827
|
+
/** @description Kisi access group reference. */
|
|
8828
|
+
kisiGroupRef?: number | null;
|
|
8829
|
+
/** @description Auto-detected language of the description. */
|
|
8830
|
+
locale: string;
|
|
8831
|
+
/**
|
|
8832
|
+
* Format: uuid
|
|
8833
|
+
* @description ID of the location.
|
|
8834
|
+
*/
|
|
8835
|
+
locationRef: string;
|
|
8836
|
+
/** @description Images attached to the resource. */
|
|
8837
|
+
media: {
|
|
8838
|
+
/** @description Storage key of the image. */
|
|
8839
|
+
key: string;
|
|
8840
|
+
/** @description Public URL of the image. */
|
|
8841
|
+
url?: string;
|
|
8735
8842
|
}[];
|
|
8736
|
-
|
|
8737
|
-
|
|
8738
|
-
|
|
8739
|
-
/** @description Description of the resource. */
|
|
8740
|
-
description: string;
|
|
8741
|
-
/** @description Booking duration bounds. */
|
|
8742
|
-
duration: {
|
|
8743
|
-
/** @description Maximum booking duration in minutes. */
|
|
8744
|
-
max: number;
|
|
8745
|
-
/** @description Minimum booking duration in minutes. */
|
|
8746
|
-
min: number;
|
|
8747
|
-
/** @description Duration limits for public bookers. */
|
|
8748
|
-
public: {
|
|
8749
|
-
/** @description Whether public bookers have separate duration limits. */
|
|
8843
|
+
/** @description Money pricing settings. */
|
|
8844
|
+
money: {
|
|
8845
|
+
/** @description Whether customers can pay with money. */
|
|
8750
8846
|
enabled: boolean;
|
|
8751
|
-
/** @description
|
|
8752
|
-
|
|
8753
|
-
|
|
8754
|
-
|
|
8847
|
+
/** @description Stepped money pricing tiers. */
|
|
8848
|
+
tiers: {
|
|
8849
|
+
/** @description Fixed fee added for this tier. */
|
|
8850
|
+
flatAmount: number;
|
|
8851
|
+
/** @description Start of this price tier in booking minutes. */
|
|
8852
|
+
from: number;
|
|
8853
|
+
/** @description Variable price per unit within this tier. */
|
|
8854
|
+
unitAmount: number;
|
|
8855
|
+
}[];
|
|
8755
8856
|
};
|
|
8756
|
-
|
|
8757
|
-
|
|
8758
|
-
|
|
8759
|
-
|
|
8760
|
-
|
|
8761
|
-
/**
|
|
8762
|
-
|
|
8763
|
-
|
|
8764
|
-
|
|
8765
|
-
|
|
8766
|
-
/** @description Google Calendar integration settings. */
|
|
8767
|
-
googleCalendar?: {
|
|
8768
|
-
/** @description Google Calendar id. */
|
|
8769
|
-
id: string;
|
|
8770
|
-
/** @description Whether two-way sync is enabled. */
|
|
8771
|
-
twoWaySyncEnabled: boolean;
|
|
8772
|
-
};
|
|
8773
|
-
/**
|
|
8774
|
-
* Format: uuid
|
|
8775
|
-
* @description Unique identifier of the resource.
|
|
8776
|
-
*/
|
|
8777
|
-
id: string;
|
|
8778
|
-
/** @description Public URL of the resource image. */
|
|
8779
|
-
imageUrl?: string;
|
|
8780
|
-
/** @description Kisi access group reference. */
|
|
8781
|
-
kisiGroupRef?: number | null;
|
|
8782
|
-
/** @description Auto-detected language of the description. */
|
|
8783
|
-
locale: string;
|
|
8784
|
-
/**
|
|
8785
|
-
* Format: uuid
|
|
8786
|
-
* @description ID of the location.
|
|
8787
|
-
*/
|
|
8788
|
-
locationRef: string;
|
|
8789
|
-
/** @description Images attached to the resource. */
|
|
8790
|
-
media: {
|
|
8791
|
-
/** @description Storage key of the image. */
|
|
8792
|
-
key: string;
|
|
8793
|
-
/** @description Public URL of the image. */
|
|
8794
|
-
url?: string;
|
|
8795
|
-
}[];
|
|
8796
|
-
/** @description Money pricing settings. */
|
|
8797
|
-
money: {
|
|
8798
|
-
/** @description Whether customers can pay with money. */
|
|
8799
|
-
enabled: boolean;
|
|
8800
|
-
/** @description Stepped money pricing tiers. */
|
|
8801
|
-
tiers: {
|
|
8802
|
-
/** @description Fixed fee added for this tier. */
|
|
8803
|
-
flatAmount: number;
|
|
8804
|
-
/** @description Start of this price tier in booking minutes. */
|
|
8805
|
-
from: number;
|
|
8806
|
-
/** @description Variable price per unit within this tier. */
|
|
8807
|
-
unitAmount: number;
|
|
8808
|
-
}[];
|
|
8809
|
-
};
|
|
8810
|
-
/**
|
|
8811
|
-
* Format: uuid
|
|
8812
|
-
* @description ID of the network.
|
|
8813
|
-
*/
|
|
8814
|
-
networkRef: string;
|
|
8815
|
-
/**
|
|
8816
|
-
* Format: uuid
|
|
8817
|
-
* @description Parent resource id when this is a child resource.
|
|
8818
|
-
*/
|
|
8819
|
-
parentRef?: string;
|
|
8820
|
-
/** @description Plan tiers configured on the resource. */
|
|
8821
|
-
plans?: {
|
|
8822
|
-
/** @description Whether plan-based access is enabled. */
|
|
8823
|
-
enabled: boolean;
|
|
8857
|
+
/**
|
|
8858
|
+
* Format: uuid
|
|
8859
|
+
* @description ID of the network.
|
|
8860
|
+
*/
|
|
8861
|
+
networkRef: string;
|
|
8862
|
+
/**
|
|
8863
|
+
* Format: uuid
|
|
8864
|
+
* @description Parent resource id when this is a child resource.
|
|
8865
|
+
*/
|
|
8866
|
+
parentRef?: string;
|
|
8824
8867
|
/** @description Plan tiers configured on the resource. */
|
|
8825
|
-
|
|
8826
|
-
/** @description
|
|
8827
|
-
|
|
8828
|
-
|
|
8829
|
-
|
|
8830
|
-
|
|
8831
|
-
|
|
8832
|
-
id: string;
|
|
8833
|
-
}[];
|
|
8834
|
-
/** @description Number of billing cycles in the tier. */
|
|
8835
|
-
commitmentCycles: number;
|
|
8836
|
-
/** @description Credits included in the tier. */
|
|
8837
|
-
credits: number;
|
|
8838
|
-
/** @description Day passes included in the tier. */
|
|
8839
|
-
dayPasses?: number;
|
|
8840
|
-
/** @description Description of the tier. */
|
|
8841
|
-
description?: string;
|
|
8842
|
-
/**
|
|
8843
|
-
* @deprecated
|
|
8844
|
-
* @description Synthetic discount percentages by product type.
|
|
8845
|
-
*/
|
|
8846
|
-
discounts?: {
|
|
8847
|
-
/** @description Discount percentage for credit packages. */
|
|
8848
|
-
creditPackages?: number;
|
|
8849
|
-
/** @description Discount percentage for desk bookings. */
|
|
8850
|
-
desks?: number;
|
|
8851
|
-
/** @description Discount percentage for equipment bookings. */
|
|
8852
|
-
equipment?: number;
|
|
8853
|
-
/** @description Discount percentage for events. */
|
|
8854
|
-
events?: number;
|
|
8855
|
-
/** @description Discount percentage for room bookings. */
|
|
8856
|
-
rooms?: number;
|
|
8857
|
-
/** @description Discount percentage for shop products. */
|
|
8858
|
-
shop?: number;
|
|
8859
|
-
};
|
|
8860
|
-
/** @description Whether the tier grants access to the entire resource. */
|
|
8861
|
-
entire: boolean;
|
|
8862
|
-
/** @description Coupons granted to members on this tier. */
|
|
8863
|
-
grantedDiscounts: {
|
|
8864
|
-
/** @description Granted coupon details. */
|
|
8865
|
-
coupon: {
|
|
8866
|
-
/** @description Fixed discount amount. */
|
|
8867
|
-
amountOff?: number;
|
|
8868
|
-
/** @description Currency code for amountOff. */
|
|
8869
|
-
currencyCode?: string;
|
|
8870
|
-
/** @description Whether the coupon applies to credit purchases. */
|
|
8871
|
-
enabledForCredits?: boolean;
|
|
8868
|
+
plans?: {
|
|
8869
|
+
/** @description Whether plan-based access is enabled. */
|
|
8870
|
+
enabled: boolean;
|
|
8871
|
+
/** @description Plan tiers configured on the resource. */
|
|
8872
|
+
tiers: {
|
|
8873
|
+
/** @description Addons included in the tier. */
|
|
8874
|
+
addons: {
|
|
8872
8875
|
/**
|
|
8873
8876
|
* Format: uuid
|
|
8874
|
-
* @description
|
|
8877
|
+
* @description Addon id.
|
|
8875
8878
|
*/
|
|
8876
8879
|
id: string;
|
|
8877
|
-
|
|
8878
|
-
limitedItems?: {
|
|
8879
|
-
/** @description Whether item-level limits are enabled. */
|
|
8880
|
-
enabled: boolean;
|
|
8881
|
-
/** @description Items the coupon applies to when limits are enabled. */
|
|
8882
|
-
values: {
|
|
8883
|
-
/**
|
|
8884
|
-
* Format: uuid
|
|
8885
|
-
* @description Unique identifier of the limited item.
|
|
8886
|
-
*/
|
|
8887
|
-
id: string;
|
|
8888
|
-
/** @description Display name of the limited item. */
|
|
8889
|
-
title?: string;
|
|
8890
|
-
/**
|
|
8891
|
-
* @description Product type of the limited item.
|
|
8892
|
-
* @enum {string}
|
|
8893
|
-
*/
|
|
8894
|
-
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
8895
|
-
}[];
|
|
8896
|
-
};
|
|
8897
|
-
/** @description Redemption limits for the coupon. */
|
|
8898
|
-
limitedRedemption?: {
|
|
8899
|
-
/** @description Whether redemption limits are enabled. */
|
|
8900
|
-
enabled: boolean;
|
|
8901
|
-
/** @description Current redemption count. */
|
|
8902
|
-
usage: number;
|
|
8903
|
-
/** @description Maximum redemption count. */
|
|
8904
|
-
value: number;
|
|
8905
|
-
};
|
|
8906
|
-
/** @description Percentage discount. */
|
|
8907
|
-
percentOff?: number;
|
|
8908
|
-
/** @description Product types the coupon applies to. */
|
|
8909
|
-
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
8910
|
-
};
|
|
8911
|
-
}[];
|
|
8912
|
-
/**
|
|
8913
|
-
* Format: uuid
|
|
8914
|
-
* @description Unique identifier of the tier.
|
|
8915
|
-
*/
|
|
8916
|
-
id: string;
|
|
8917
|
-
/**
|
|
8918
|
-
* @description Billing period of the tier.
|
|
8919
|
-
* @enum {string}
|
|
8920
|
-
*/
|
|
8921
|
-
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
8922
|
-
/** @description Nested plan details on responses. */
|
|
8923
|
-
plan: {
|
|
8880
|
+
}[];
|
|
8924
8881
|
/** @description Number of billing cycles in the tier. */
|
|
8925
8882
|
commitmentCycles: number;
|
|
8926
8883
|
/** @description Credits included in the tier. */
|
|
8927
8884
|
credits: number;
|
|
8928
8885
|
/** @description Day passes included in the tier. */
|
|
8929
|
-
dayPasses
|
|
8886
|
+
dayPasses?: number;
|
|
8887
|
+
/** @description Description of the tier. */
|
|
8888
|
+
description?: string;
|
|
8930
8889
|
/**
|
|
8931
8890
|
* @deprecated
|
|
8932
8891
|
* @description Synthetic discount percentages by product type.
|
|
@@ -8945,6 +8904,8 @@ interface components {
|
|
|
8945
8904
|
/** @description Discount percentage for shop products. */
|
|
8946
8905
|
shop?: number;
|
|
8947
8906
|
};
|
|
8907
|
+
/** @description Whether the tier grants access to the entire resource. */
|
|
8908
|
+
entire: boolean;
|
|
8948
8909
|
/** @description Coupons granted to members on this tier. */
|
|
8949
8910
|
grantedDiscounts: {
|
|
8950
8911
|
/** @description Granted coupon details. */
|
|
@@ -9005,244 +8966,1295 @@ interface components {
|
|
|
9005
8966
|
* @enum {string}
|
|
9006
8967
|
*/
|
|
9007
8968
|
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
8969
|
+
/** @description Nested plan details on responses. */
|
|
8970
|
+
plan: {
|
|
8971
|
+
/** @description Number of billing cycles in the tier. */
|
|
8972
|
+
commitmentCycles: number;
|
|
8973
|
+
/** @description Credits included in the tier. */
|
|
8974
|
+
credits: number;
|
|
8975
|
+
/** @description Day passes included in the tier. */
|
|
8976
|
+
dayPasses: number;
|
|
8977
|
+
/**
|
|
8978
|
+
* @deprecated
|
|
8979
|
+
* @description Synthetic discount percentages by product type.
|
|
8980
|
+
*/
|
|
8981
|
+
discounts?: {
|
|
8982
|
+
/** @description Discount percentage for credit packages. */
|
|
8983
|
+
creditPackages?: number;
|
|
8984
|
+
/** @description Discount percentage for desk bookings. */
|
|
8985
|
+
desks?: number;
|
|
8986
|
+
/** @description Discount percentage for equipment bookings. */
|
|
8987
|
+
equipment?: number;
|
|
8988
|
+
/** @description Discount percentage for events. */
|
|
8989
|
+
events?: number;
|
|
8990
|
+
/** @description Discount percentage for room bookings. */
|
|
8991
|
+
rooms?: number;
|
|
8992
|
+
/** @description Discount percentage for shop products. */
|
|
8993
|
+
shop?: number;
|
|
8994
|
+
};
|
|
8995
|
+
/** @description Coupons granted to members on this tier. */
|
|
8996
|
+
grantedDiscounts: {
|
|
8997
|
+
/** @description Granted coupon details. */
|
|
8998
|
+
coupon: {
|
|
8999
|
+
/** @description Fixed discount amount. */
|
|
9000
|
+
amountOff?: number;
|
|
9001
|
+
/** @description Currency code for amountOff. */
|
|
9002
|
+
currencyCode?: string;
|
|
9003
|
+
/** @description Whether the coupon applies to credit purchases. */
|
|
9004
|
+
enabledForCredits?: boolean;
|
|
9005
|
+
/**
|
|
9006
|
+
* Format: uuid
|
|
9007
|
+
* @description Unique identifier of the coupon.
|
|
9008
|
+
*/
|
|
9009
|
+
id: string;
|
|
9010
|
+
/** @description Item-level redemption limits. */
|
|
9011
|
+
limitedItems?: {
|
|
9012
|
+
/** @description Whether item-level limits are enabled. */
|
|
9013
|
+
enabled: boolean;
|
|
9014
|
+
/** @description Items the coupon applies to when limits are enabled. */
|
|
9015
|
+
values: {
|
|
9016
|
+
/**
|
|
9017
|
+
* Format: uuid
|
|
9018
|
+
* @description Unique identifier of the limited item.
|
|
9019
|
+
*/
|
|
9020
|
+
id: string;
|
|
9021
|
+
/** @description Display name of the limited item. */
|
|
9022
|
+
title?: string;
|
|
9023
|
+
/**
|
|
9024
|
+
* @description Product type of the limited item.
|
|
9025
|
+
* @enum {string}
|
|
9026
|
+
*/
|
|
9027
|
+
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
9028
|
+
}[];
|
|
9029
|
+
};
|
|
9030
|
+
/** @description Redemption limits for the coupon. */
|
|
9031
|
+
limitedRedemption?: {
|
|
9032
|
+
/** @description Whether redemption limits are enabled. */
|
|
9033
|
+
enabled: boolean;
|
|
9034
|
+
/** @description Current redemption count. */
|
|
9035
|
+
usage: number;
|
|
9036
|
+
/** @description Maximum redemption count. */
|
|
9037
|
+
value: number;
|
|
9038
|
+
};
|
|
9039
|
+
/** @description Percentage discount. */
|
|
9040
|
+
percentOff?: number;
|
|
9041
|
+
/** @description Product types the coupon applies to. */
|
|
9042
|
+
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
9043
|
+
};
|
|
9044
|
+
}[];
|
|
9045
|
+
/**
|
|
9046
|
+
* Format: uuid
|
|
9047
|
+
* @description Unique identifier of the tier.
|
|
9048
|
+
*/
|
|
9049
|
+
id: string;
|
|
9050
|
+
/**
|
|
9051
|
+
* @description Billing period of the tier.
|
|
9052
|
+
* @enum {string}
|
|
9053
|
+
*/
|
|
9054
|
+
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
9055
|
+
/** @description Price of the tier. */
|
|
9056
|
+
price: number;
|
|
9057
|
+
/** @description Title of the tier. */
|
|
9058
|
+
title: string;
|
|
9059
|
+
};
|
|
9008
9060
|
/** @description Price of the tier. */
|
|
9009
9061
|
price: number;
|
|
9062
|
+
/** @description Self sign-up settings of the tier. */
|
|
9063
|
+
selfSignup: {
|
|
9064
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
9065
|
+
enabled: boolean;
|
|
9066
|
+
/** @description Self sign-up flow type for the tier. */
|
|
9067
|
+
type: string;
|
|
9068
|
+
};
|
|
9069
|
+
/**
|
|
9070
|
+
* @deprecated
|
|
9071
|
+
* @description Deprecated. Use selfSignup.type instead. Self sign-up flow type for the tier.
|
|
9072
|
+
*/
|
|
9073
|
+
selfSignupType?: string;
|
|
9074
|
+
/** @description One-time setup fee for the tier. */
|
|
9075
|
+
setupFee: number;
|
|
9010
9076
|
/** @description Title of the tier. */
|
|
9011
9077
|
title: string;
|
|
9078
|
+
}[];
|
|
9079
|
+
};
|
|
9080
|
+
/**
|
|
9081
|
+
* @deprecated
|
|
9082
|
+
* @description Deprecated. Use bufferTime instead.
|
|
9083
|
+
* @enum {string}
|
|
9084
|
+
*/
|
|
9085
|
+
preparationMinutes: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
9086
|
+
/**
|
|
9087
|
+
* @description Refund threshold for cancellations.
|
|
9088
|
+
* @enum {string}
|
|
9089
|
+
*/
|
|
9090
|
+
refundThreshold: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
9091
|
+
/**
|
|
9092
|
+
* Format: uuid
|
|
9093
|
+
* @description Salto KS access group reference.
|
|
9094
|
+
*/
|
|
9095
|
+
saltoksAccessGroupRef?: string | null;
|
|
9096
|
+
/** @description Availability schedule. */
|
|
9097
|
+
schedule?: {
|
|
9098
|
+
/** @description Default availability schedule. */
|
|
9099
|
+
default: {
|
|
9100
|
+
/** @description Dates in MM-DD format when the resource is closed. */
|
|
9101
|
+
closedDays: string[];
|
|
9102
|
+
/** @description Weekly availability windows for members. */
|
|
9103
|
+
items: {
|
|
9104
|
+
/** @description Weekdays this time window applies to. */
|
|
9105
|
+
days: {
|
|
9106
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9107
|
+
friday: boolean;
|
|
9108
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9109
|
+
monday: boolean;
|
|
9110
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9111
|
+
saturday: boolean;
|
|
9112
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9113
|
+
sunday: boolean;
|
|
9114
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9115
|
+
thursday: boolean;
|
|
9116
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9117
|
+
tuesday: boolean;
|
|
9118
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9119
|
+
wednesday: boolean;
|
|
9120
|
+
};
|
|
9121
|
+
/** @description Open hours for the selected weekdays. */
|
|
9122
|
+
hours: {
|
|
9123
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9124
|
+
from: string;
|
|
9125
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9126
|
+
to: string;
|
|
9127
|
+
};
|
|
9128
|
+
}[];
|
|
9012
9129
|
};
|
|
9013
|
-
/** @description
|
|
9014
|
-
|
|
9015
|
-
/** @description
|
|
9016
|
-
|
|
9017
|
-
/** @description
|
|
9130
|
+
/** @description Whether scheduling is enabled. */
|
|
9131
|
+
enabled: boolean;
|
|
9132
|
+
/** @description Public availability schedule. */
|
|
9133
|
+
public: {
|
|
9134
|
+
/** @description Dates in MM-DD format when the resource is closed for public bookers. */
|
|
9135
|
+
closedDays: string[];
|
|
9136
|
+
/** @description Whether the public schedule is enabled. */
|
|
9018
9137
|
enabled: boolean;
|
|
9019
|
-
/** @description
|
|
9020
|
-
|
|
9138
|
+
/** @description Weekly availability windows for public bookers. */
|
|
9139
|
+
items: {
|
|
9140
|
+
/** @description Weekdays this time window applies to. */
|
|
9141
|
+
days: {
|
|
9142
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9143
|
+
friday: boolean;
|
|
9144
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9145
|
+
monday: boolean;
|
|
9146
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9147
|
+
saturday: boolean;
|
|
9148
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9149
|
+
sunday: boolean;
|
|
9150
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9151
|
+
thursday: boolean;
|
|
9152
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9153
|
+
tuesday: boolean;
|
|
9154
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9155
|
+
wednesday: boolean;
|
|
9156
|
+
};
|
|
9157
|
+
/** @description Open hours for the selected weekdays. */
|
|
9158
|
+
hours: {
|
|
9159
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9160
|
+
from: string;
|
|
9161
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9162
|
+
to: string;
|
|
9163
|
+
};
|
|
9164
|
+
}[];
|
|
9021
9165
|
};
|
|
9166
|
+
};
|
|
9167
|
+
/**
|
|
9168
|
+
* Format: uuid
|
|
9169
|
+
* @description Tapkey access group reference.
|
|
9170
|
+
*/
|
|
9171
|
+
tapkeyGroupRef?: string | null;
|
|
9172
|
+
/** @description Display name of the resource. */
|
|
9173
|
+
title: string;
|
|
9174
|
+
/**
|
|
9175
|
+
* @description Type of the resource.
|
|
9176
|
+
* @enum {string}
|
|
9177
|
+
*/
|
|
9178
|
+
type: "dedicatedDesk" | "equipment" | "hotDesk" | "office" | "parkingLot" | "room" | "station" | "conferenceRoom" | "eventSpace" | "meetingRoom" | "phoneBooth" | "studio";
|
|
9179
|
+
/** @description UniFi Access policy reference. */
|
|
9180
|
+
unifiAccessGroupRef?: string | null;
|
|
9181
|
+
/**
|
|
9182
|
+
* @description Visibility of the resource.
|
|
9183
|
+
* @enum {string}
|
|
9184
|
+
*/
|
|
9185
|
+
visibility: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9186
|
+
}[];
|
|
9187
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
9188
|
+
searchQueryNext?: string;
|
|
9189
|
+
};
|
|
9190
|
+
getResource: {
|
|
9191
|
+
/** @description The resource. */
|
|
9192
|
+
resource: {
|
|
9193
|
+
/** @description Active resource assignments. */
|
|
9194
|
+
assignments: {
|
|
9022
9195
|
/**
|
|
9023
9196
|
* @deprecated
|
|
9024
|
-
* @description Deprecated. Use
|
|
9197
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
9025
9198
|
*/
|
|
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
|
-
|
|
9053
|
-
|
|
9054
|
-
|
|
9055
|
-
|
|
9056
|
-
|
|
9057
|
-
|
|
9058
|
-
/** @description
|
|
9059
|
-
|
|
9060
|
-
/** @description
|
|
9061
|
-
|
|
9062
|
-
/** @description Whether Saturday is included in this schedule window. */
|
|
9063
|
-
saturday: boolean;
|
|
9064
|
-
/** @description Whether Sunday is included in this schedule window. */
|
|
9065
|
-
sunday: boolean;
|
|
9066
|
-
/** @description Whether Thursday is included in this schedule window. */
|
|
9067
|
-
thursday: boolean;
|
|
9068
|
-
/** @description Whether Tuesday is included in this schedule window. */
|
|
9069
|
-
tuesday: boolean;
|
|
9070
|
-
/** @description Whether Wednesday is included in this schedule window. */
|
|
9071
|
-
wednesday: boolean;
|
|
9072
|
-
};
|
|
9073
|
-
/** @description Open hours for the selected weekdays. */
|
|
9074
|
-
hours: {
|
|
9075
|
-
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9076
|
-
from: string;
|
|
9077
|
-
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9078
|
-
to: string;
|
|
9199
|
+
company?: {
|
|
9200
|
+
/**
|
|
9201
|
+
* Format: uuid
|
|
9202
|
+
* @description Company id.
|
|
9203
|
+
*/
|
|
9204
|
+
id: string;
|
|
9205
|
+
/** @description Company name. */
|
|
9206
|
+
title: string;
|
|
9207
|
+
};
|
|
9208
|
+
/** @description Customer the resource is assigned to. */
|
|
9209
|
+
customer?: {
|
|
9210
|
+
/**
|
|
9211
|
+
* Format: uuid
|
|
9212
|
+
* @description Customer id.
|
|
9213
|
+
*/
|
|
9214
|
+
id: string;
|
|
9215
|
+
/** @description Company name when the customer is a company. */
|
|
9216
|
+
title?: string;
|
|
9217
|
+
/**
|
|
9218
|
+
* @description Whether the customer is a user or company.
|
|
9219
|
+
* @enum {string}
|
|
9220
|
+
*/
|
|
9221
|
+
type: "user" | "company";
|
|
9222
|
+
/** @description User details when the customer is a user. */
|
|
9223
|
+
user?: {
|
|
9224
|
+
/** @description User email. */
|
|
9225
|
+
email?: string | null;
|
|
9226
|
+
/**
|
|
9227
|
+
* Format: uuid
|
|
9228
|
+
* @description User id.
|
|
9229
|
+
*/
|
|
9230
|
+
id: string;
|
|
9231
|
+
/** @description User first name. */
|
|
9232
|
+
name?: string | null;
|
|
9233
|
+
/** @description User last name. */
|
|
9234
|
+
surname?: string | null;
|
|
9079
9235
|
};
|
|
9080
|
-
}
|
|
9081
|
-
|
|
9082
|
-
|
|
9083
|
-
|
|
9084
|
-
|
|
9085
|
-
|
|
9086
|
-
|
|
9087
|
-
|
|
9088
|
-
/**
|
|
9236
|
+
};
|
|
9237
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
9238
|
+
entire: boolean;
|
|
9239
|
+
/**
|
|
9240
|
+
* Format: uuid
|
|
9241
|
+
* @description Assignment id.
|
|
9242
|
+
*/
|
|
9243
|
+
id?: string;
|
|
9244
|
+
/**
|
|
9245
|
+
* @deprecated
|
|
9246
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
9247
|
+
*/
|
|
9248
|
+
membership?: {
|
|
9249
|
+
/**
|
|
9250
|
+
* Format: uuid
|
|
9251
|
+
* @description Membership id.
|
|
9252
|
+
*/
|
|
9253
|
+
id: string;
|
|
9254
|
+
};
|
|
9255
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9256
|
+
quantity?: number;
|
|
9257
|
+
/**
|
|
9258
|
+
* Format: uuid
|
|
9259
|
+
* @description UUID of the resource the assignment belongs to.
|
|
9260
|
+
*/
|
|
9261
|
+
resourceRef: string;
|
|
9262
|
+
/** @description Subscription backing this assignment. */
|
|
9263
|
+
subscription: {
|
|
9264
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
9265
|
+
endDate?: string;
|
|
9266
|
+
/**
|
|
9267
|
+
* Format: uuid
|
|
9268
|
+
* @description Subscription id.
|
|
9269
|
+
*/
|
|
9270
|
+
id: string;
|
|
9271
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
9272
|
+
startDate: string;
|
|
9273
|
+
};
|
|
9274
|
+
/**
|
|
9275
|
+
* @deprecated
|
|
9276
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
9277
|
+
*/
|
|
9278
|
+
user?: {
|
|
9279
|
+
/** @description User email. */
|
|
9280
|
+
email?: string | null;
|
|
9281
|
+
/**
|
|
9282
|
+
* Format: uuid
|
|
9283
|
+
* @description User id.
|
|
9284
|
+
*/
|
|
9285
|
+
id: string;
|
|
9286
|
+
/** @description User first name. */
|
|
9287
|
+
name?: string | null;
|
|
9288
|
+
/** @description User last name. */
|
|
9289
|
+
surname?: string | null;
|
|
9290
|
+
};
|
|
9291
|
+
}[];
|
|
9292
|
+
/** @description Auto-release settings for no-show bookings. */
|
|
9293
|
+
autoRelease?: {
|
|
9294
|
+
/** @description Whether auto-release is enabled. */
|
|
9089
9295
|
enabled: boolean;
|
|
9090
|
-
/**
|
|
9091
|
-
|
|
9092
|
-
|
|
9093
|
-
|
|
9094
|
-
|
|
9095
|
-
friday: boolean;
|
|
9096
|
-
/** @description Whether Monday is included in this schedule window. */
|
|
9097
|
-
monday: boolean;
|
|
9098
|
-
/** @description Whether Saturday is included in this schedule window. */
|
|
9099
|
-
saturday: boolean;
|
|
9100
|
-
/** @description Whether Sunday is included in this schedule window. */
|
|
9101
|
-
sunday: boolean;
|
|
9102
|
-
/** @description Whether Thursday is included in this schedule window. */
|
|
9103
|
-
thursday: boolean;
|
|
9104
|
-
/** @description Whether Tuesday is included in this schedule window. */
|
|
9105
|
-
tuesday: boolean;
|
|
9106
|
-
/** @description Whether Wednesday is included in this schedule window. */
|
|
9107
|
-
wednesday: boolean;
|
|
9108
|
-
};
|
|
9109
|
-
/** @description Open hours for the selected weekdays. */
|
|
9110
|
-
hours: {
|
|
9111
|
-
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9112
|
-
from: string;
|
|
9113
|
-
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9114
|
-
to: string;
|
|
9115
|
-
};
|
|
9116
|
-
}[];
|
|
9296
|
+
/**
|
|
9297
|
+
* @description Minutes after start or creation before the slot is released.
|
|
9298
|
+
* @enum {string}
|
|
9299
|
+
*/
|
|
9300
|
+
interval: "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
9117
9301
|
};
|
|
9118
|
-
|
|
9119
|
-
|
|
9120
|
-
|
|
9121
|
-
|
|
9122
|
-
|
|
9123
|
-
|
|
9124
|
-
|
|
9125
|
-
|
|
9126
|
-
|
|
9127
|
-
|
|
9128
|
-
|
|
9129
|
-
|
|
9130
|
-
|
|
9131
|
-
|
|
9132
|
-
|
|
9133
|
-
|
|
9134
|
-
|
|
9135
|
-
|
|
9136
|
-
|
|
9137
|
-
|
|
9138
|
-
|
|
9139
|
-
|
|
9140
|
-
|
|
9141
|
-
|
|
9302
|
+
/** @description Avigilon Alta access group reference. */
|
|
9303
|
+
avigilonAltaGroupRef?: number | null;
|
|
9304
|
+
/**
|
|
9305
|
+
* @description Who can create bookings on this resource.
|
|
9306
|
+
* @enum {string}
|
|
9307
|
+
*/
|
|
9308
|
+
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9309
|
+
/** @description Booking step size in minutes. */
|
|
9310
|
+
bookingStepMinutes?: number;
|
|
9311
|
+
/** @description Brivo access group reference. */
|
|
9312
|
+
brivoGroupRef?: number | null;
|
|
9313
|
+
/**
|
|
9314
|
+
* @description Buffer time blocked before each booking.
|
|
9315
|
+
* @enum {string}
|
|
9316
|
+
*/
|
|
9317
|
+
bufferTime: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
9318
|
+
/** @description Maximum capacity per booking. */
|
|
9319
|
+
capacity?: number | null;
|
|
9320
|
+
/** @description Check-in settings. */
|
|
9321
|
+
checkIn?: {
|
|
9322
|
+
/**
|
|
9323
|
+
* @description How early before start the guest must check in.
|
|
9324
|
+
* @enum {string}
|
|
9325
|
+
*/
|
|
9326
|
+
interval: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes";
|
|
9327
|
+
};
|
|
9328
|
+
/** @description Child resources when this is a parent resource. Bookings on a child resource also block the parent. */
|
|
9329
|
+
children: {
|
|
9142
9330
|
/**
|
|
9143
9331
|
* Format: uuid
|
|
9144
|
-
* @description
|
|
9332
|
+
* @description Id of the child resource.
|
|
9145
9333
|
*/
|
|
9146
9334
|
id: string;
|
|
9147
|
-
/** @description
|
|
9335
|
+
/** @description Title of the child resource. */
|
|
9148
9336
|
title: string;
|
|
9337
|
+
}[];
|
|
9338
|
+
/** @description Confirmation email settings. */
|
|
9339
|
+
confirmationEmail: {
|
|
9340
|
+
/** @description Send confirmation when an admin creates a booking. */
|
|
9341
|
+
bookingCreatedByAdmin: boolean;
|
|
9342
|
+
/** @description Send confirmation when a member creates a booking. */
|
|
9343
|
+
bookingCreatedByMember: boolean;
|
|
9344
|
+
/** @description Send confirmation when a network member creates a booking. */
|
|
9345
|
+
bookingCreatedByNetworkMember: boolean;
|
|
9346
|
+
/** @description Send confirmation when a public user creates a booking. */
|
|
9347
|
+
bookingCreatedByPublic: boolean;
|
|
9348
|
+
/** @description Email template id for confirmation emails. */
|
|
9349
|
+
template: string;
|
|
9149
9350
|
};
|
|
9150
|
-
/**
|
|
9151
|
-
|
|
9351
|
+
/**
|
|
9352
|
+
* Format: date-time
|
|
9353
|
+
* @description ISO timestamp of when the resource was created.
|
|
9354
|
+
*/
|
|
9355
|
+
createDate: string;
|
|
9356
|
+
/** @description Credit pricing settings. */
|
|
9357
|
+
credits: {
|
|
9358
|
+
/** @description Whether customers can pay with location credits. */
|
|
9359
|
+
enabled: boolean;
|
|
9360
|
+
/** @description Stepped credit pricing tiers. */
|
|
9361
|
+
tiers: {
|
|
9362
|
+
/** @description Fixed fee added for this tier. */
|
|
9363
|
+
flatAmount: number;
|
|
9364
|
+
/** @description Start of this price tier in booking minutes. */
|
|
9365
|
+
from: number;
|
|
9366
|
+
/** @description Variable price per unit within this tier. */
|
|
9367
|
+
unitAmount: number;
|
|
9368
|
+
}[];
|
|
9369
|
+
};
|
|
9370
|
+
/** @description Whether day passes are enabled. */
|
|
9371
|
+
dayPassesEnabled?: boolean;
|
|
9372
|
+
/** @description Description of the resource. */
|
|
9373
|
+
description: string;
|
|
9374
|
+
/** @description Booking duration bounds. */
|
|
9375
|
+
duration: {
|
|
9376
|
+
/** @description Maximum booking duration in minutes. */
|
|
9377
|
+
max: number;
|
|
9378
|
+
/** @description Minimum booking duration in minutes. */
|
|
9379
|
+
min: number;
|
|
9380
|
+
/** @description Duration limits for public bookers. */
|
|
9381
|
+
public: {
|
|
9382
|
+
/** @description Whether public bookers have separate duration limits. */
|
|
9383
|
+
enabled: boolean;
|
|
9384
|
+
/** @description Maximum booking duration in minutes for public bookers. */
|
|
9385
|
+
max: number;
|
|
9386
|
+
/** @description Minimum booking duration in minutes for public bookers. */
|
|
9387
|
+
min: number;
|
|
9388
|
+
};
|
|
9389
|
+
};
|
|
9390
|
+
/** @description Dynamic pricing settings. */
|
|
9391
|
+
dynamicPricing: {
|
|
9392
|
+
/** @description Maximum price increase percentage when demand is high. */
|
|
9393
|
+
deltaAbove: number;
|
|
9394
|
+
/** @description Maximum price decrease percentage when demand is low. */
|
|
9395
|
+
deltaBelow: number;
|
|
9396
|
+
/** @description Whether dynamic pricing is enabled. */
|
|
9397
|
+
enabled: boolean;
|
|
9398
|
+
};
|
|
9399
|
+
/** @description Google Calendar integration settings. */
|
|
9400
|
+
googleCalendar?: {
|
|
9401
|
+
/** @description Google Calendar id. */
|
|
9402
|
+
id: string;
|
|
9403
|
+
/** @description Whether two-way sync is enabled. */
|
|
9404
|
+
twoWaySyncEnabled: boolean;
|
|
9405
|
+
};
|
|
9406
|
+
/**
|
|
9407
|
+
* Format: uuid
|
|
9408
|
+
* @description Unique identifier of the resource.
|
|
9409
|
+
*/
|
|
9410
|
+
id: string;
|
|
9411
|
+
/** @description Public URL of the resource image. */
|
|
9412
|
+
imageUrl?: string;
|
|
9413
|
+
/** @description Kisi access group reference. */
|
|
9414
|
+
kisiGroupRef?: number | null;
|
|
9415
|
+
/** @description Auto-detected language of the description. */
|
|
9416
|
+
locale: string;
|
|
9417
|
+
/**
|
|
9418
|
+
* Format: uuid
|
|
9419
|
+
* @description ID of the location.
|
|
9420
|
+
*/
|
|
9421
|
+
locationRef: string;
|
|
9422
|
+
/** @description Images attached to the resource. */
|
|
9423
|
+
media: {
|
|
9424
|
+
/** @description Storage key of the image. */
|
|
9425
|
+
key: string;
|
|
9426
|
+
/** @description Public URL of the image. */
|
|
9427
|
+
url?: string;
|
|
9428
|
+
}[];
|
|
9429
|
+
/** @description Money pricing settings. */
|
|
9430
|
+
money: {
|
|
9431
|
+
/** @description Whether customers can pay with money. */
|
|
9432
|
+
enabled: boolean;
|
|
9433
|
+
/** @description Stepped money pricing tiers. */
|
|
9434
|
+
tiers: {
|
|
9435
|
+
/** @description Fixed fee added for this tier. */
|
|
9436
|
+
flatAmount: number;
|
|
9437
|
+
/** @description Start of this price tier in booking minutes. */
|
|
9438
|
+
from: number;
|
|
9439
|
+
/** @description Variable price per unit within this tier. */
|
|
9440
|
+
unitAmount: number;
|
|
9441
|
+
}[];
|
|
9442
|
+
};
|
|
9443
|
+
/**
|
|
9444
|
+
* Format: uuid
|
|
9445
|
+
* @description ID of the network.
|
|
9446
|
+
*/
|
|
9447
|
+
networkRef: string;
|
|
9448
|
+
/**
|
|
9449
|
+
* Format: uuid
|
|
9450
|
+
* @description Parent resource id when this is a child resource.
|
|
9451
|
+
*/
|
|
9452
|
+
parentRef?: string;
|
|
9453
|
+
/** @description Plan tiers configured on the resource. */
|
|
9454
|
+
plans?: {
|
|
9455
|
+
/** @description Whether plan-based access is enabled. */
|
|
9456
|
+
enabled: boolean;
|
|
9457
|
+
/** @description Plan tiers configured on the resource. */
|
|
9458
|
+
tiers: {
|
|
9459
|
+
/** @description Addons included in the tier. */
|
|
9460
|
+
addons: {
|
|
9461
|
+
/**
|
|
9462
|
+
* Format: uuid
|
|
9463
|
+
* @description Addon id.
|
|
9464
|
+
*/
|
|
9465
|
+
id: string;
|
|
9466
|
+
}[];
|
|
9467
|
+
/** @description Number of billing cycles in the tier. */
|
|
9468
|
+
commitmentCycles: number;
|
|
9469
|
+
/** @description Credits included in the tier. */
|
|
9470
|
+
credits: number;
|
|
9471
|
+
/** @description Day passes included in the tier. */
|
|
9472
|
+
dayPasses?: number;
|
|
9473
|
+
/** @description Description of the tier. */
|
|
9474
|
+
description?: string;
|
|
9475
|
+
/**
|
|
9476
|
+
* @deprecated
|
|
9477
|
+
* @description Synthetic discount percentages by product type.
|
|
9478
|
+
*/
|
|
9479
|
+
discounts?: {
|
|
9480
|
+
/** @description Discount percentage for credit packages. */
|
|
9481
|
+
creditPackages?: number;
|
|
9482
|
+
/** @description Discount percentage for desk bookings. */
|
|
9483
|
+
desks?: number;
|
|
9484
|
+
/** @description Discount percentage for equipment bookings. */
|
|
9485
|
+
equipment?: number;
|
|
9486
|
+
/** @description Discount percentage for events. */
|
|
9487
|
+
events?: number;
|
|
9488
|
+
/** @description Discount percentage for room bookings. */
|
|
9489
|
+
rooms?: number;
|
|
9490
|
+
/** @description Discount percentage for shop products. */
|
|
9491
|
+
shop?: number;
|
|
9492
|
+
};
|
|
9493
|
+
/** @description Whether the tier grants access to the entire resource. */
|
|
9494
|
+
entire: boolean;
|
|
9495
|
+
/** @description Coupons granted to members on this tier. */
|
|
9496
|
+
grantedDiscounts: {
|
|
9497
|
+
/** @description Granted coupon details. */
|
|
9498
|
+
coupon: {
|
|
9499
|
+
/** @description Fixed discount amount. */
|
|
9500
|
+
amountOff?: number;
|
|
9501
|
+
/** @description Currency code for amountOff. */
|
|
9502
|
+
currencyCode?: string;
|
|
9503
|
+
/** @description Whether the coupon applies to credit purchases. */
|
|
9504
|
+
enabledForCredits?: boolean;
|
|
9505
|
+
/**
|
|
9506
|
+
* Format: uuid
|
|
9507
|
+
* @description Unique identifier of the coupon.
|
|
9508
|
+
*/
|
|
9509
|
+
id: string;
|
|
9510
|
+
/** @description Item-level redemption limits. */
|
|
9511
|
+
limitedItems?: {
|
|
9512
|
+
/** @description Whether item-level limits are enabled. */
|
|
9513
|
+
enabled: boolean;
|
|
9514
|
+
/** @description Items the coupon applies to when limits are enabled. */
|
|
9515
|
+
values: {
|
|
9516
|
+
/**
|
|
9517
|
+
* Format: uuid
|
|
9518
|
+
* @description Unique identifier of the limited item.
|
|
9519
|
+
*/
|
|
9520
|
+
id: string;
|
|
9521
|
+
/** @description Display name of the limited item. */
|
|
9522
|
+
title?: string;
|
|
9523
|
+
/**
|
|
9524
|
+
* @description Product type of the limited item.
|
|
9525
|
+
* @enum {string}
|
|
9526
|
+
*/
|
|
9527
|
+
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
9528
|
+
}[];
|
|
9529
|
+
};
|
|
9530
|
+
/** @description Redemption limits for the coupon. */
|
|
9531
|
+
limitedRedemption?: {
|
|
9532
|
+
/** @description Whether redemption limits are enabled. */
|
|
9533
|
+
enabled: boolean;
|
|
9534
|
+
/** @description Current redemption count. */
|
|
9535
|
+
usage: number;
|
|
9536
|
+
/** @description Maximum redemption count. */
|
|
9537
|
+
value: number;
|
|
9538
|
+
};
|
|
9539
|
+
/** @description Percentage discount. */
|
|
9540
|
+
percentOff?: number;
|
|
9541
|
+
/** @description Product types the coupon applies to. */
|
|
9542
|
+
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
9543
|
+
};
|
|
9544
|
+
}[];
|
|
9545
|
+
/**
|
|
9546
|
+
* Format: uuid
|
|
9547
|
+
* @description Unique identifier of the tier.
|
|
9548
|
+
*/
|
|
9549
|
+
id: string;
|
|
9550
|
+
/**
|
|
9551
|
+
* @description Billing period of the tier.
|
|
9552
|
+
* @enum {string}
|
|
9553
|
+
*/
|
|
9554
|
+
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
9555
|
+
/** @description Nested plan details on responses. */
|
|
9556
|
+
plan: {
|
|
9557
|
+
/** @description Number of billing cycles in the tier. */
|
|
9558
|
+
commitmentCycles: number;
|
|
9559
|
+
/** @description Credits included in the tier. */
|
|
9560
|
+
credits: number;
|
|
9561
|
+
/** @description Day passes included in the tier. */
|
|
9562
|
+
dayPasses: number;
|
|
9563
|
+
/**
|
|
9564
|
+
* @deprecated
|
|
9565
|
+
* @description Synthetic discount percentages by product type.
|
|
9566
|
+
*/
|
|
9567
|
+
discounts?: {
|
|
9568
|
+
/** @description Discount percentage for credit packages. */
|
|
9569
|
+
creditPackages?: number;
|
|
9570
|
+
/** @description Discount percentage for desk bookings. */
|
|
9571
|
+
desks?: number;
|
|
9572
|
+
/** @description Discount percentage for equipment bookings. */
|
|
9573
|
+
equipment?: number;
|
|
9574
|
+
/** @description Discount percentage for events. */
|
|
9575
|
+
events?: number;
|
|
9576
|
+
/** @description Discount percentage for room bookings. */
|
|
9577
|
+
rooms?: number;
|
|
9578
|
+
/** @description Discount percentage for shop products. */
|
|
9579
|
+
shop?: number;
|
|
9580
|
+
};
|
|
9581
|
+
/** @description Coupons granted to members on this tier. */
|
|
9582
|
+
grantedDiscounts: {
|
|
9583
|
+
/** @description Granted coupon details. */
|
|
9584
|
+
coupon: {
|
|
9585
|
+
/** @description Fixed discount amount. */
|
|
9586
|
+
amountOff?: number;
|
|
9587
|
+
/** @description Currency code for amountOff. */
|
|
9588
|
+
currencyCode?: string;
|
|
9589
|
+
/** @description Whether the coupon applies to credit purchases. */
|
|
9590
|
+
enabledForCredits?: boolean;
|
|
9591
|
+
/**
|
|
9592
|
+
* Format: uuid
|
|
9593
|
+
* @description Unique identifier of the coupon.
|
|
9594
|
+
*/
|
|
9595
|
+
id: string;
|
|
9596
|
+
/** @description Item-level redemption limits. */
|
|
9597
|
+
limitedItems?: {
|
|
9598
|
+
/** @description Whether item-level limits are enabled. */
|
|
9599
|
+
enabled: boolean;
|
|
9600
|
+
/** @description Items the coupon applies to when limits are enabled. */
|
|
9601
|
+
values: {
|
|
9602
|
+
/**
|
|
9603
|
+
* Format: uuid
|
|
9604
|
+
* @description Unique identifier of the limited item.
|
|
9605
|
+
*/
|
|
9606
|
+
id: string;
|
|
9607
|
+
/** @description Display name of the limited item. */
|
|
9608
|
+
title?: string;
|
|
9609
|
+
/**
|
|
9610
|
+
* @description Product type of the limited item.
|
|
9611
|
+
* @enum {string}
|
|
9612
|
+
*/
|
|
9613
|
+
type: "roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems";
|
|
9614
|
+
}[];
|
|
9615
|
+
};
|
|
9616
|
+
/** @description Redemption limits for the coupon. */
|
|
9617
|
+
limitedRedemption?: {
|
|
9618
|
+
/** @description Whether redemption limits are enabled. */
|
|
9619
|
+
enabled: boolean;
|
|
9620
|
+
/** @description Current redemption count. */
|
|
9621
|
+
usage: number;
|
|
9622
|
+
/** @description Maximum redemption count. */
|
|
9623
|
+
value: number;
|
|
9624
|
+
};
|
|
9625
|
+
/** @description Percentage discount. */
|
|
9626
|
+
percentOff?: number;
|
|
9627
|
+
/** @description Product types the coupon applies to. */
|
|
9628
|
+
productTypes?: ("roomBookings" | "eventSpaceBookings" | "conferenceRoomBookings" | "meetingRoomBookings" | "phoneBoothBookings" | "stationBookings" | "studioBookings" | "hotDeskBookings" | "dedicatedDeskBookings" | "parkingBookings" | "equipmentBookings" | "eventTickets" | "shopProducts" | "packages" | "subscriptionItems")[];
|
|
9629
|
+
};
|
|
9630
|
+
}[];
|
|
9631
|
+
/**
|
|
9632
|
+
* Format: uuid
|
|
9633
|
+
* @description Unique identifier of the tier.
|
|
9634
|
+
*/
|
|
9635
|
+
id: string;
|
|
9636
|
+
/**
|
|
9637
|
+
* @description Billing period of the tier.
|
|
9638
|
+
* @enum {string}
|
|
9639
|
+
*/
|
|
9640
|
+
period: "day" | "week" | "month" | "threeMonths" | "sixMonths" | "year";
|
|
9641
|
+
/** @description Price of the tier. */
|
|
9642
|
+
price: number;
|
|
9643
|
+
/** @description Title of the tier. */
|
|
9644
|
+
title: string;
|
|
9645
|
+
};
|
|
9646
|
+
/** @description Price of the tier. */
|
|
9647
|
+
price: number;
|
|
9648
|
+
/** @description Self sign-up settings of the tier. */
|
|
9649
|
+
selfSignup: {
|
|
9650
|
+
/** @description Whether members may self-enroll into the tier. */
|
|
9651
|
+
enabled: boolean;
|
|
9652
|
+
/** @description Self sign-up flow type for the tier. */
|
|
9653
|
+
type: string;
|
|
9654
|
+
};
|
|
9655
|
+
/**
|
|
9656
|
+
* @deprecated
|
|
9657
|
+
* @description Deprecated. Use selfSignup.type instead. Self sign-up flow type for the tier.
|
|
9658
|
+
*/
|
|
9659
|
+
selfSignupType?: string;
|
|
9660
|
+
/** @description One-time setup fee for the tier. */
|
|
9661
|
+
setupFee: number;
|
|
9662
|
+
/** @description Title of the tier. */
|
|
9663
|
+
title: string;
|
|
9664
|
+
}[];
|
|
9665
|
+
};
|
|
9666
|
+
/**
|
|
9667
|
+
* @deprecated
|
|
9668
|
+
* @description Deprecated. Use bufferTime instead.
|
|
9669
|
+
* @enum {string}
|
|
9670
|
+
*/
|
|
9671
|
+
preparationMinutes: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
9672
|
+
/**
|
|
9673
|
+
* @description Refund threshold for cancellations.
|
|
9674
|
+
* @enum {string}
|
|
9675
|
+
*/
|
|
9676
|
+
refundThreshold: "noRefund" | "zeroMinutes" | "fifteenMinutes" | "thirtyMinutes" | "oneHour" | "twoHours" | "fourHours" | "sixHours" | "twelveHours" | "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "fourWeeks";
|
|
9677
|
+
/**
|
|
9678
|
+
* Format: uuid
|
|
9679
|
+
* @description Salto KS access group reference.
|
|
9680
|
+
*/
|
|
9681
|
+
saltoksAccessGroupRef?: string | null;
|
|
9682
|
+
/** @description Availability schedule. */
|
|
9683
|
+
schedule?: {
|
|
9684
|
+
/** @description Default availability schedule. */
|
|
9685
|
+
default: {
|
|
9686
|
+
/** @description Dates in MM-DD format when the resource is closed. */
|
|
9687
|
+
closedDays: string[];
|
|
9688
|
+
/** @description Weekly availability windows for members. */
|
|
9689
|
+
items: {
|
|
9690
|
+
/** @description Weekdays this time window applies to. */
|
|
9691
|
+
days: {
|
|
9692
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9693
|
+
friday: boolean;
|
|
9694
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9695
|
+
monday: boolean;
|
|
9696
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9697
|
+
saturday: boolean;
|
|
9698
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9699
|
+
sunday: boolean;
|
|
9700
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9701
|
+
thursday: boolean;
|
|
9702
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9703
|
+
tuesday: boolean;
|
|
9704
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9705
|
+
wednesday: boolean;
|
|
9706
|
+
};
|
|
9707
|
+
/** @description Open hours for the selected weekdays. */
|
|
9708
|
+
hours: {
|
|
9709
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9710
|
+
from: string;
|
|
9711
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9712
|
+
to: string;
|
|
9713
|
+
};
|
|
9714
|
+
}[];
|
|
9715
|
+
};
|
|
9716
|
+
/** @description Whether scheduling is enabled. */
|
|
9717
|
+
enabled: boolean;
|
|
9718
|
+
/** @description Public availability schedule. */
|
|
9719
|
+
public: {
|
|
9720
|
+
/** @description Dates in MM-DD format when the resource is closed for public bookers. */
|
|
9721
|
+
closedDays: string[];
|
|
9722
|
+
/** @description Whether the public schedule is enabled. */
|
|
9723
|
+
enabled: boolean;
|
|
9724
|
+
/** @description Weekly availability windows for public bookers. */
|
|
9725
|
+
items: {
|
|
9726
|
+
/** @description Weekdays this time window applies to. */
|
|
9727
|
+
days: {
|
|
9728
|
+
/** @description Whether Friday is included in this schedule window. */
|
|
9729
|
+
friday: boolean;
|
|
9730
|
+
/** @description Whether Monday is included in this schedule window. */
|
|
9731
|
+
monday: boolean;
|
|
9732
|
+
/** @description Whether Saturday is included in this schedule window. */
|
|
9733
|
+
saturday: boolean;
|
|
9734
|
+
/** @description Whether Sunday is included in this schedule window. */
|
|
9735
|
+
sunday: boolean;
|
|
9736
|
+
/** @description Whether Thursday is included in this schedule window. */
|
|
9737
|
+
thursday: boolean;
|
|
9738
|
+
/** @description Whether Tuesday is included in this schedule window. */
|
|
9739
|
+
tuesday: boolean;
|
|
9740
|
+
/** @description Whether Wednesday is included in this schedule window. */
|
|
9741
|
+
wednesday: boolean;
|
|
9742
|
+
};
|
|
9743
|
+
/** @description Open hours for the selected weekdays. */
|
|
9744
|
+
hours: {
|
|
9745
|
+
/** @description Opening time in 24-hour "HH:mm" format. */
|
|
9746
|
+
from: string;
|
|
9747
|
+
/** @description Closing time in 24-hour "HH:mm" format. */
|
|
9748
|
+
to: string;
|
|
9749
|
+
};
|
|
9750
|
+
}[];
|
|
9751
|
+
};
|
|
9752
|
+
};
|
|
9753
|
+
/**
|
|
9754
|
+
* Format: uuid
|
|
9755
|
+
* @description Tapkey access group reference.
|
|
9756
|
+
*/
|
|
9757
|
+
tapkeyGroupRef?: string | null;
|
|
9758
|
+
/** @description Display name of the resource. */
|
|
9759
|
+
title: string;
|
|
9760
|
+
/**
|
|
9761
|
+
* @description Type of the resource.
|
|
9762
|
+
* @enum {string}
|
|
9763
|
+
*/
|
|
9764
|
+
type: "dedicatedDesk" | "equipment" | "hotDesk" | "office" | "parkingLot" | "room" | "station" | "conferenceRoom" | "eventSpace" | "meetingRoom" | "phoneBooth" | "studio";
|
|
9765
|
+
/** @description UniFi Access policy reference. */
|
|
9766
|
+
unifiAccessGroupRef?: string | null;
|
|
9767
|
+
/**
|
|
9768
|
+
* @description Visibility of the resource.
|
|
9769
|
+
* @enum {string}
|
|
9770
|
+
*/
|
|
9771
|
+
visibility: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9772
|
+
};
|
|
9773
|
+
};
|
|
9774
|
+
getAssignments: {
|
|
9775
|
+
/** @description List of resource assignments in the location. */
|
|
9776
|
+
assignments: {
|
|
9777
|
+
/**
|
|
9778
|
+
* @deprecated
|
|
9779
|
+
* @description Deprecated. Use customer instead. Company assigned to the resource.
|
|
9780
|
+
*/
|
|
9781
|
+
company?: {
|
|
9782
|
+
/**
|
|
9783
|
+
* Format: uuid
|
|
9784
|
+
* @description Company id.
|
|
9785
|
+
*/
|
|
9786
|
+
id: string;
|
|
9787
|
+
/** @description Company name. */
|
|
9788
|
+
title: string;
|
|
9789
|
+
};
|
|
9790
|
+
/** @description Customer the resource is assigned to. */
|
|
9791
|
+
customer?: {
|
|
9792
|
+
/**
|
|
9793
|
+
* Format: uuid
|
|
9794
|
+
* @description Customer id.
|
|
9795
|
+
*/
|
|
9796
|
+
id: string;
|
|
9797
|
+
/** @description Company name when the customer is a company. */
|
|
9798
|
+
title?: string;
|
|
9799
|
+
/**
|
|
9800
|
+
* @description Whether the customer is a user or company.
|
|
9801
|
+
* @enum {string}
|
|
9802
|
+
*/
|
|
9803
|
+
type: "user" | "company";
|
|
9804
|
+
/** @description User details when the customer is a user. */
|
|
9805
|
+
user?: {
|
|
9806
|
+
/** @description User email. */
|
|
9807
|
+
email?: string | null;
|
|
9808
|
+
/**
|
|
9809
|
+
* Format: uuid
|
|
9810
|
+
* @description User id.
|
|
9811
|
+
*/
|
|
9812
|
+
id: string;
|
|
9813
|
+
/** @description User first name. */
|
|
9814
|
+
name?: string | null;
|
|
9815
|
+
/** @description User last name. */
|
|
9816
|
+
surname?: string | null;
|
|
9817
|
+
};
|
|
9818
|
+
};
|
|
9819
|
+
/** @description Whether the assignment grants access to the entire resource. */
|
|
9820
|
+
entire: boolean;
|
|
9821
|
+
/**
|
|
9822
|
+
* Format: uuid
|
|
9823
|
+
* @description Assignment id.
|
|
9824
|
+
*/
|
|
9825
|
+
id?: string;
|
|
9826
|
+
/**
|
|
9827
|
+
* @deprecated
|
|
9828
|
+
* @description Deprecated. Use customer instead. Membership linked to the assignment.
|
|
9829
|
+
*/
|
|
9830
|
+
membership?: {
|
|
9831
|
+
/**
|
|
9832
|
+
* Format: uuid
|
|
9833
|
+
* @description Membership id.
|
|
9834
|
+
*/
|
|
9835
|
+
id: string;
|
|
9836
|
+
};
|
|
9837
|
+
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9838
|
+
quantity?: number;
|
|
9839
|
+
/**
|
|
9840
|
+
* Format: uuid
|
|
9841
|
+
* @description UUID of the resource the assignment belongs to.
|
|
9842
|
+
*/
|
|
9843
|
+
resourceRef: string;
|
|
9844
|
+
/** @description Subscription backing this assignment. */
|
|
9845
|
+
subscription: {
|
|
9846
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
9847
|
+
endDate?: string;
|
|
9848
|
+
/**
|
|
9849
|
+
* Format: uuid
|
|
9850
|
+
* @description Subscription id.
|
|
9851
|
+
*/
|
|
9852
|
+
id: string;
|
|
9853
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
9854
|
+
startDate: string;
|
|
9855
|
+
};
|
|
9856
|
+
/**
|
|
9857
|
+
* @deprecated
|
|
9858
|
+
* @description Deprecated. Use customer instead. User assigned to the resource.
|
|
9859
|
+
*/
|
|
9860
|
+
user?: {
|
|
9861
|
+
/** @description User email. */
|
|
9862
|
+
email?: string | null;
|
|
9863
|
+
/**
|
|
9864
|
+
* Format: uuid
|
|
9865
|
+
* @description User id.
|
|
9866
|
+
*/
|
|
9867
|
+
id: string;
|
|
9868
|
+
/** @description User first name. */
|
|
9869
|
+
name?: string | null;
|
|
9870
|
+
/** @description User last name. */
|
|
9871
|
+
surname?: string | null;
|
|
9872
|
+
};
|
|
9873
|
+
}[];
|
|
9874
|
+
};
|
|
9875
|
+
getBookings: {
|
|
9876
|
+
/** @description List of bookings. */
|
|
9877
|
+
bookings: {
|
|
9878
|
+
/** @description Attendees of the booking. Empty when the caller has no access to booking details. */
|
|
9879
|
+
attendees: {
|
|
9880
|
+
/**
|
|
9881
|
+
* Format: uuid
|
|
9882
|
+
* @description Membership id of the attendee.
|
|
9883
|
+
*/
|
|
9884
|
+
membershipRef?: string;
|
|
9885
|
+
/** @description User profile of the attendee. */
|
|
9886
|
+
user?: {
|
|
9887
|
+
/** @description Short bio of the user. */
|
|
9888
|
+
about?: string | null;
|
|
9889
|
+
/** @description Company the user belongs to, if any. */
|
|
9890
|
+
company?: {
|
|
9891
|
+
/** @description Company display name. */
|
|
9892
|
+
title: string;
|
|
9893
|
+
} | null;
|
|
9894
|
+
/**
|
|
9895
|
+
* Format: email
|
|
9896
|
+
* @description Email address of the user.
|
|
9897
|
+
*/
|
|
9898
|
+
email?: string | null;
|
|
9899
|
+
/**
|
|
9900
|
+
* Format: uuid
|
|
9901
|
+
* @description Unique identifier of the user.
|
|
9902
|
+
*/
|
|
9903
|
+
id: string;
|
|
9904
|
+
/** @description First name of the user. */
|
|
9905
|
+
name?: string | null;
|
|
9906
|
+
/** @description Phone number of the user. */
|
|
9907
|
+
phoneNumber?: string | null;
|
|
9908
|
+
/** @description Profile photo URL of the user. */
|
|
9909
|
+
photoUrl?: string | null;
|
|
9910
|
+
/** @description Last name of the user. */
|
|
9911
|
+
surname?: string | null;
|
|
9912
|
+
};
|
|
9913
|
+
}[];
|
|
9914
|
+
/**
|
|
9915
|
+
* Format: date-time
|
|
9916
|
+
* @description ISO timestamp when the booking was created.
|
|
9917
|
+
*/
|
|
9918
|
+
createDate: string;
|
|
9919
|
+
/**
|
|
9920
|
+
* Format: date-time
|
|
9921
|
+
* @description ISO timestamp when the booking was cancelled.
|
|
9922
|
+
*/
|
|
9923
|
+
deleteDate?: string;
|
|
9924
|
+
/**
|
|
9925
|
+
* Format: date-time
|
|
9926
|
+
* @description ISO timestamp when the booking ends.
|
|
9927
|
+
*/
|
|
9928
|
+
endDate: string;
|
|
9929
|
+
/** @description Whether the booking reserves the entire resource rather than individual seats. */
|
|
9930
|
+
entire?: boolean;
|
|
9931
|
+
/** @description Unique identifier of the booking. For recurring occurrences, formatted as `{bookingId}_{isoDate}`. */
|
|
9932
|
+
id: string;
|
|
9933
|
+
/**
|
|
9934
|
+
* Format: uuid
|
|
9935
|
+
* @deprecated
|
|
9936
|
+
* @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
|
|
9937
|
+
*/
|
|
9938
|
+
membershipRefOwner?: string;
|
|
9939
|
+
/** @description Internal note. Visible to admins only. */
|
|
9940
|
+
memo?: string;
|
|
9941
|
+
/**
|
|
9942
|
+
* @deprecated
|
|
9943
|
+
* @description Deprecated. Use `payments` instead.
|
|
9944
|
+
*/
|
|
9945
|
+
payment?: {
|
|
9946
|
+
/** @description Payment amount in the location currency. */
|
|
9947
|
+
amount?: number;
|
|
9948
|
+
/** @description ISO 4217 currency code. */
|
|
9949
|
+
currencyCode?: string;
|
|
9950
|
+
/** @description ID of the associated invoice item. */
|
|
9951
|
+
invoiceItemRef?: string;
|
|
9952
|
+
/**
|
|
9953
|
+
* @description Payment status.
|
|
9954
|
+
* @enum {string}
|
|
9955
|
+
*/
|
|
9956
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
9957
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
9958
|
+
surcharge?: {
|
|
9959
|
+
money: {
|
|
9960
|
+
/** @description Surcharge amount. */
|
|
9961
|
+
amount?: number;
|
|
9962
|
+
/** @description ISO 4217 currency code. */
|
|
9963
|
+
currencyCode?: string;
|
|
9964
|
+
/** @description Surcharge percentage applied. */
|
|
9965
|
+
percentage?: number;
|
|
9966
|
+
/** @description Surcharge rate. */
|
|
9967
|
+
rate?: number;
|
|
9968
|
+
};
|
|
9969
|
+
/**
|
|
9970
|
+
* @description Surcharge type.
|
|
9971
|
+
* @enum {string}
|
|
9972
|
+
*/
|
|
9973
|
+
type: "money";
|
|
9974
|
+
};
|
|
9975
|
+
/** @description ID of the associated transaction. */
|
|
9976
|
+
transactionRef?: string;
|
|
9977
|
+
/** @description Payment method type. */
|
|
9978
|
+
type?: string;
|
|
9979
|
+
};
|
|
9980
|
+
/** @description Payment details. Omitted when caller has no access. */
|
|
9981
|
+
payments?: {
|
|
9982
|
+
/** @description Payment amount in the location currency. */
|
|
9983
|
+
amount?: number;
|
|
9984
|
+
/** @description ISO 4217 currency code. */
|
|
9985
|
+
currencyCode?: string;
|
|
9986
|
+
/** @description ID of the associated invoice item. */
|
|
9987
|
+
invoiceItemRef?: string;
|
|
9988
|
+
/**
|
|
9989
|
+
* @description Payment status.
|
|
9990
|
+
* @enum {string}
|
|
9991
|
+
*/
|
|
9992
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
9993
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
9994
|
+
surcharge?: {
|
|
9995
|
+
money: {
|
|
9996
|
+
/** @description Surcharge amount. */
|
|
9997
|
+
amount?: number;
|
|
9998
|
+
/** @description ISO 4217 currency code. */
|
|
9999
|
+
currencyCode?: string;
|
|
10000
|
+
/** @description Surcharge percentage applied. */
|
|
10001
|
+
percentage?: number;
|
|
10002
|
+
/** @description Surcharge rate. */
|
|
10003
|
+
rate?: number;
|
|
10004
|
+
};
|
|
10005
|
+
/**
|
|
10006
|
+
* @description Surcharge type.
|
|
10007
|
+
* @enum {string}
|
|
10008
|
+
*/
|
|
10009
|
+
type: "money";
|
|
10010
|
+
};
|
|
10011
|
+
/** @description ID of the associated transaction. */
|
|
10012
|
+
transactionRef?: string;
|
|
10013
|
+
/** @description Payment method type. */
|
|
10014
|
+
type?: string;
|
|
10015
|
+
}[];
|
|
10016
|
+
/**
|
|
10017
|
+
* Format: uuid
|
|
10018
|
+
* @description ID of the booked resource.
|
|
10019
|
+
*/
|
|
10020
|
+
resourceRef: string;
|
|
10021
|
+
/** @description Number of seats reserved. */
|
|
10022
|
+
seats?: number;
|
|
10023
|
+
/**
|
|
10024
|
+
* Format: date-time
|
|
10025
|
+
* @description ISO timestamp when the booking starts.
|
|
10026
|
+
*/
|
|
10027
|
+
startDate: string;
|
|
10028
|
+
/** @description Custom booking title. Omitted when the owner has restricted title visibility. */
|
|
10029
|
+
title?: string;
|
|
10030
|
+
/**
|
|
10031
|
+
* Format: date-time
|
|
10032
|
+
* @description ISO timestamp when the booking was last updated.
|
|
10033
|
+
*/
|
|
10034
|
+
updateDate?: string;
|
|
10035
|
+
/** @description Profile of the booking owner. Omitted when the owner has restricted visibility. */
|
|
10036
|
+
userOwner?: {
|
|
10037
|
+
/** @description Short bio of the user. */
|
|
10038
|
+
about?: string | null;
|
|
10039
|
+
/** @description Company the user belongs to, if any. */
|
|
10040
|
+
company?: {
|
|
10041
|
+
/** @description Company display name. */
|
|
10042
|
+
title: string;
|
|
10043
|
+
} | null;
|
|
10044
|
+
/**
|
|
10045
|
+
* Format: email
|
|
10046
|
+
* @description Email address of the user.
|
|
10047
|
+
*/
|
|
10048
|
+
email?: string | null;
|
|
10049
|
+
/**
|
|
10050
|
+
* Format: uuid
|
|
10051
|
+
* @description Unique identifier of the user.
|
|
10052
|
+
*/
|
|
10053
|
+
id: string;
|
|
10054
|
+
/** @description First name of the user. */
|
|
10055
|
+
name?: string | null;
|
|
10056
|
+
/** @description Phone number of the user. */
|
|
10057
|
+
phoneNumber?: string | null;
|
|
10058
|
+
/** @description Profile photo URL of the user. */
|
|
10059
|
+
photoUrl?: string | null;
|
|
10060
|
+
/** @description Last name of the user. */
|
|
10061
|
+
surname?: string | null;
|
|
10062
|
+
};
|
|
10063
|
+
}[];
|
|
10064
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
10065
|
+
nextPageToken?: string;
|
|
10066
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
10067
|
+
searchQueryNext?: string;
|
|
10068
|
+
};
|
|
10069
|
+
getBooking: {
|
|
10070
|
+
/** @description The booking. */
|
|
10071
|
+
booking: {
|
|
10072
|
+
/** @description Attendees of the booking. Empty when the caller has no access to booking details. */
|
|
10073
|
+
attendees: {
|
|
10074
|
+
/**
|
|
10075
|
+
* Format: uuid
|
|
10076
|
+
* @description Membership id of the attendee.
|
|
10077
|
+
*/
|
|
10078
|
+
membershipRef?: string;
|
|
10079
|
+
/** @description User profile of the attendee. */
|
|
10080
|
+
user?: {
|
|
10081
|
+
/** @description Short bio of the user. */
|
|
10082
|
+
about?: string | null;
|
|
10083
|
+
/** @description Company the user belongs to, if any. */
|
|
10084
|
+
company?: {
|
|
10085
|
+
/** @description Company display name. */
|
|
10086
|
+
title: string;
|
|
10087
|
+
} | null;
|
|
10088
|
+
/**
|
|
10089
|
+
* Format: email
|
|
10090
|
+
* @description Email address of the user.
|
|
10091
|
+
*/
|
|
10092
|
+
email?: string | null;
|
|
10093
|
+
/**
|
|
10094
|
+
* Format: uuid
|
|
10095
|
+
* @description Unique identifier of the user.
|
|
10096
|
+
*/
|
|
10097
|
+
id: string;
|
|
10098
|
+
/** @description First name of the user. */
|
|
10099
|
+
name?: string | null;
|
|
10100
|
+
/** @description Phone number of the user. */
|
|
10101
|
+
phoneNumber?: string | null;
|
|
10102
|
+
/** @description Profile photo URL of the user. */
|
|
10103
|
+
photoUrl?: string | null;
|
|
10104
|
+
/** @description Last name of the user. */
|
|
10105
|
+
surname?: string | null;
|
|
10106
|
+
};
|
|
10107
|
+
}[];
|
|
10108
|
+
/**
|
|
10109
|
+
* Format: date-time
|
|
10110
|
+
* @description ISO timestamp when the booking was created.
|
|
10111
|
+
*/
|
|
10112
|
+
createDate: string;
|
|
10113
|
+
/**
|
|
10114
|
+
* Format: date-time
|
|
10115
|
+
* @description ISO timestamp when the booking was cancelled.
|
|
10116
|
+
*/
|
|
10117
|
+
deleteDate?: string;
|
|
10118
|
+
/**
|
|
10119
|
+
* Format: date-time
|
|
10120
|
+
* @description ISO timestamp when the booking ends.
|
|
10121
|
+
*/
|
|
10122
|
+
endDate: string;
|
|
10123
|
+
/** @description Whether the booking reserves the entire resource rather than individual seats. */
|
|
10124
|
+
entire?: boolean;
|
|
10125
|
+
/** @description Unique identifier of the booking. For recurring occurrences, formatted as `{bookingId}_{isoDate}`. */
|
|
10126
|
+
id: string;
|
|
10127
|
+
/**
|
|
10128
|
+
* Format: uuid
|
|
10129
|
+
* @deprecated
|
|
10130
|
+
* @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
|
|
10131
|
+
*/
|
|
10132
|
+
membershipRefOwner?: string;
|
|
10133
|
+
/** @description Internal note. Visible to admins only. */
|
|
10134
|
+
memo?: string;
|
|
10135
|
+
/**
|
|
10136
|
+
* @deprecated
|
|
10137
|
+
* @description Deprecated. Use `payments` instead.
|
|
10138
|
+
*/
|
|
10139
|
+
payment?: {
|
|
10140
|
+
/** @description Payment amount in the location currency. */
|
|
10141
|
+
amount?: number;
|
|
10142
|
+
/** @description ISO 4217 currency code. */
|
|
10143
|
+
currencyCode?: string;
|
|
10144
|
+
/** @description ID of the associated invoice item. */
|
|
10145
|
+
invoiceItemRef?: string;
|
|
10146
|
+
/**
|
|
10147
|
+
* @description Payment status.
|
|
10148
|
+
* @enum {string}
|
|
10149
|
+
*/
|
|
10150
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10151
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
10152
|
+
surcharge?: {
|
|
10153
|
+
money: {
|
|
10154
|
+
/** @description Surcharge amount. */
|
|
10155
|
+
amount?: number;
|
|
10156
|
+
/** @description ISO 4217 currency code. */
|
|
10157
|
+
currencyCode?: string;
|
|
10158
|
+
/** @description Surcharge percentage applied. */
|
|
10159
|
+
percentage?: number;
|
|
10160
|
+
/** @description Surcharge rate. */
|
|
10161
|
+
rate?: number;
|
|
10162
|
+
};
|
|
10163
|
+
/**
|
|
10164
|
+
* @description Surcharge type.
|
|
10165
|
+
* @enum {string}
|
|
10166
|
+
*/
|
|
10167
|
+
type: "money";
|
|
10168
|
+
};
|
|
10169
|
+
/** @description ID of the associated transaction. */
|
|
10170
|
+
transactionRef?: string;
|
|
10171
|
+
/** @description Payment method type. */
|
|
10172
|
+
type?: string;
|
|
10173
|
+
};
|
|
10174
|
+
/** @description Payment details. Omitted when caller has no access. */
|
|
10175
|
+
payments?: {
|
|
10176
|
+
/** @description Payment amount in the location currency. */
|
|
10177
|
+
amount?: number;
|
|
10178
|
+
/** @description ISO 4217 currency code. */
|
|
10179
|
+
currencyCode?: string;
|
|
10180
|
+
/** @description ID of the associated invoice item. */
|
|
10181
|
+
invoiceItemRef?: string;
|
|
10182
|
+
/**
|
|
10183
|
+
* @description Payment status.
|
|
10184
|
+
* @enum {string}
|
|
10185
|
+
*/
|
|
10186
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10187
|
+
/** @description Surcharge applied to the payment, if any. */
|
|
10188
|
+
surcharge?: {
|
|
10189
|
+
money: {
|
|
10190
|
+
/** @description Surcharge amount. */
|
|
10191
|
+
amount?: number;
|
|
10192
|
+
/** @description ISO 4217 currency code. */
|
|
10193
|
+
currencyCode?: string;
|
|
10194
|
+
/** @description Surcharge percentage applied. */
|
|
10195
|
+
percentage?: number;
|
|
10196
|
+
/** @description Surcharge rate. */
|
|
10197
|
+
rate?: number;
|
|
10198
|
+
};
|
|
10199
|
+
/**
|
|
10200
|
+
* @description Surcharge type.
|
|
10201
|
+
* @enum {string}
|
|
10202
|
+
*/
|
|
10203
|
+
type: "money";
|
|
10204
|
+
};
|
|
10205
|
+
/** @description ID of the associated transaction. */
|
|
10206
|
+
transactionRef?: string;
|
|
10207
|
+
/** @description Payment method type. */
|
|
10208
|
+
type?: string;
|
|
10209
|
+
}[];
|
|
9152
10210
|
/**
|
|
9153
10211
|
* Format: uuid
|
|
9154
|
-
* @description
|
|
10212
|
+
* @description ID of the booked resource.
|
|
9155
10213
|
*/
|
|
9156
|
-
|
|
9157
|
-
/** @description
|
|
9158
|
-
|
|
9159
|
-
/**
|
|
9160
|
-
* Format: uuid
|
|
9161
|
-
* @description Membership id.
|
|
9162
|
-
*/
|
|
9163
|
-
id: string;
|
|
9164
|
-
};
|
|
9165
|
-
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9166
|
-
quantity?: number;
|
|
10214
|
+
resourceRef: string;
|
|
10215
|
+
/** @description Number of seats reserved. */
|
|
10216
|
+
seats?: number;
|
|
9167
10217
|
/**
|
|
9168
|
-
* Format:
|
|
9169
|
-
* @description
|
|
10218
|
+
* Format: date-time
|
|
10219
|
+
* @description ISO timestamp when the booking starts.
|
|
9170
10220
|
*/
|
|
9171
|
-
|
|
9172
|
-
/** @description
|
|
9173
|
-
|
|
9174
|
-
|
|
9175
|
-
|
|
10221
|
+
startDate: string;
|
|
10222
|
+
/** @description Custom booking title. Omitted when the owner has restricted title visibility. */
|
|
10223
|
+
title?: string;
|
|
10224
|
+
/**
|
|
10225
|
+
* Format: date-time
|
|
10226
|
+
* @description ISO timestamp when the booking was last updated.
|
|
10227
|
+
*/
|
|
10228
|
+
updateDate?: string;
|
|
10229
|
+
/** @description Profile of the booking owner. Omitted when the owner has restricted visibility. */
|
|
10230
|
+
userOwner?: {
|
|
10231
|
+
/** @description Short bio of the user. */
|
|
10232
|
+
about?: string | null;
|
|
10233
|
+
/** @description Company the user belongs to, if any. */
|
|
10234
|
+
company?: {
|
|
10235
|
+
/** @description Company display name. */
|
|
10236
|
+
title: string;
|
|
10237
|
+
} | null;
|
|
9176
10238
|
/**
|
|
9177
|
-
* Format:
|
|
9178
|
-
* @description
|
|
10239
|
+
* Format: email
|
|
10240
|
+
* @description Email address of the user.
|
|
9179
10241
|
*/
|
|
9180
|
-
id: string;
|
|
9181
|
-
/** @description ISO timestamp when the assignment starts. */
|
|
9182
|
-
startDate: string;
|
|
9183
|
-
};
|
|
9184
|
-
/** @description User assigned to the resource. */
|
|
9185
|
-
user?: {
|
|
9186
|
-
/** @description User email. */
|
|
9187
10242
|
email?: string | null;
|
|
9188
10243
|
/**
|
|
9189
10244
|
* Format: uuid
|
|
9190
|
-
* @description
|
|
10245
|
+
* @description Unique identifier of the user.
|
|
9191
10246
|
*/
|
|
9192
10247
|
id: string;
|
|
9193
|
-
/** @description
|
|
10248
|
+
/** @description First name of the user. */
|
|
9194
10249
|
name?: string | null;
|
|
9195
|
-
/** @description
|
|
10250
|
+
/** @description Phone number of the user. */
|
|
10251
|
+
phoneNumber?: string | null;
|
|
10252
|
+
/** @description Profile photo URL of the user. */
|
|
10253
|
+
photoUrl?: string | null;
|
|
10254
|
+
/** @description Last name of the user. */
|
|
9196
10255
|
surname?: string | null;
|
|
9197
10256
|
};
|
|
9198
|
-
}[];
|
|
9199
|
-
};
|
|
9200
|
-
payment: {
|
|
9201
|
-
/** @description The amount of the payment */
|
|
9202
|
-
amount?: number;
|
|
9203
|
-
/** @description The currency code of the payment */
|
|
9204
|
-
currencyCode?: string;
|
|
9205
|
-
/** @description The reference ID of the invoice item */
|
|
9206
|
-
invoiceItemRef?: string;
|
|
9207
|
-
/** @enum {string} */
|
|
9208
|
-
status?: "succeeded" | "pending" | "processing" | "canceled" | "failed";
|
|
9209
|
-
tax?: {
|
|
9210
|
-
inclusive?: boolean;
|
|
9211
|
-
rate?: number;
|
|
9212
10257
|
};
|
|
9213
|
-
/** @description The reference ID of the transaction */
|
|
9214
|
-
transactionRef?: string;
|
|
9215
|
-
/** @enum {string} */
|
|
9216
|
-
type?: "credits" | "dayPasses" | "external" | "flow" | "fondy" | "freedompay" | "invoice" | "kakaopay" | "mercadopago" | "paypal" | "paystack" | "plata" | "stripe" | "tap" | "wayforpay";
|
|
9217
|
-
};
|
|
9218
|
-
booking: {
|
|
9219
|
-
attendees?: {
|
|
9220
|
-
/** Format: uuid */
|
|
9221
|
-
membershipRef?: string;
|
|
9222
|
-
user?: components["schemas"]["user"];
|
|
9223
|
-
}[];
|
|
9224
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
9225
|
-
deleteDate?: components["schemas"]["dateSchema"];
|
|
9226
|
-
endDate?: components["schemas"]["dateSchema"];
|
|
9227
|
-
/** Format: uuid */
|
|
9228
|
-
id?: string;
|
|
9229
|
-
memo?: string;
|
|
9230
|
-
/** Format: uuid */
|
|
9231
|
-
membershipRefOwner?: string;
|
|
9232
|
-
/**
|
|
9233
|
-
* @deprecated
|
|
9234
|
-
* @description Deprecated. Use `payments` instead.
|
|
9235
|
-
*/
|
|
9236
|
-
payment?: components["schemas"]["payment"];
|
|
9237
|
-
/** @description Booking payments. Multiple entries when the booking has several ledger transactions. */
|
|
9238
|
-
payments?: components["schemas"]["payment"][];
|
|
9239
|
-
/** Format: uuid */
|
|
9240
|
-
resourceRef?: string;
|
|
9241
|
-
seats?: number;
|
|
9242
|
-
startDate?: components["schemas"]["dateSchema"];
|
|
9243
|
-
title?: string;
|
|
9244
|
-
updateDate?: components["schemas"]["dateSchema"];
|
|
9245
|
-
userOwner?: components["schemas"]["user"];
|
|
9246
10258
|
};
|
|
9247
10259
|
getShopCategories: {
|
|
9248
10260
|
/** @description List of shop categories. */
|
|
@@ -11076,6 +12088,8 @@ interface components {
|
|
|
11076
12088
|
* @enum {string}
|
|
11077
12089
|
*/
|
|
11078
12090
|
type: "oneOff" | "recurring";
|
|
12091
|
+
/** @description UniFi Access policy reference. */
|
|
12092
|
+
unifiAccessGroupRef?: string | null;
|
|
11079
12093
|
}[];
|
|
11080
12094
|
/**
|
|
11081
12095
|
* Format: uuid
|
|
@@ -11651,6 +12665,8 @@ interface components {
|
|
|
11651
12665
|
* @enum {string}
|
|
11652
12666
|
*/
|
|
11653
12667
|
type: "oneOff" | "recurring";
|
|
12668
|
+
/** @description UniFi Access policy reference. */
|
|
12669
|
+
unifiAccessGroupRef?: string | null;
|
|
11654
12670
|
}[];
|
|
11655
12671
|
/**
|
|
11656
12672
|
* Format: uuid
|
|
@@ -12227,6 +13243,8 @@ interface components {
|
|
|
12227
13243
|
* @enum {string}
|
|
12228
13244
|
*/
|
|
12229
13245
|
type: "oneOff" | "recurring";
|
|
13246
|
+
/** @description UniFi Access policy reference. */
|
|
13247
|
+
unifiAccessGroupRef?: string | null;
|
|
12230
13248
|
}[];
|
|
12231
13249
|
/**
|
|
12232
13250
|
* Format: uuid
|
|
@@ -15476,6 +16494,44 @@ interface components {
|
|
|
15476
16494
|
* @description ISO timestamp of when the visit was created.
|
|
15477
16495
|
*/
|
|
15478
16496
|
createDate: string;
|
|
16497
|
+
/** @description Host customer. */
|
|
16498
|
+
customer: {
|
|
16499
|
+
/** @description Company of the host, present when the host membership is a member of a company. */
|
|
16500
|
+
company?: {
|
|
16501
|
+
/**
|
|
16502
|
+
* Format: uuid
|
|
16503
|
+
* @description Unique identifier of the company.
|
|
16504
|
+
*/
|
|
16505
|
+
id: string;
|
|
16506
|
+
/** @description Company name. */
|
|
16507
|
+
title: string;
|
|
16508
|
+
};
|
|
16509
|
+
/**
|
|
16510
|
+
* Format: uuid
|
|
16511
|
+
* @description ID of the host customer.
|
|
16512
|
+
*/
|
|
16513
|
+
id: string;
|
|
16514
|
+
/** @description Host user details. */
|
|
16515
|
+
user: {
|
|
16516
|
+
/** @description About text of the host user. */
|
|
16517
|
+
about?: string | null;
|
|
16518
|
+
/** @description Email of the host user. */
|
|
16519
|
+
email?: string | null;
|
|
16520
|
+
/**
|
|
16521
|
+
* Format: uuid
|
|
16522
|
+
* @description Unique identifier of the host user.
|
|
16523
|
+
*/
|
|
16524
|
+
id: string;
|
|
16525
|
+
/** @description First name of the host user. */
|
|
16526
|
+
name?: string | null;
|
|
16527
|
+
/** @description Phone number of the host user. */
|
|
16528
|
+
phoneNumber?: string | null;
|
|
16529
|
+
/** @description Profile photo URL of the host user. */
|
|
16530
|
+
photoUrl?: string | null;
|
|
16531
|
+
/** @description Surname of the host user. */
|
|
16532
|
+
surname?: string | null;
|
|
16533
|
+
};
|
|
16534
|
+
};
|
|
15479
16535
|
/**
|
|
15480
16536
|
* Format: date-time
|
|
15481
16537
|
* @description ISO timestamp of the scheduled visit date.
|
|
@@ -15512,10 +16568,14 @@ interface components {
|
|
|
15512
16568
|
locationRef: string;
|
|
15513
16569
|
/**
|
|
15514
16570
|
* Format: uuid
|
|
15515
|
-
* @
|
|
16571
|
+
* @deprecated
|
|
16572
|
+
* @description Deprecated. Use customer.id instead.
|
|
15516
16573
|
*/
|
|
15517
16574
|
membershipRefHost: string;
|
|
15518
|
-
/**
|
|
16575
|
+
/**
|
|
16576
|
+
* @deprecated
|
|
16577
|
+
* @description Deprecated. Use customer.user instead.
|
|
16578
|
+
*/
|
|
15519
16579
|
userHost: {
|
|
15520
16580
|
/** @description About text of the host user. */
|
|
15521
16581
|
about?: string | null;
|
|
@@ -17067,6 +18127,8 @@ interface components {
|
|
|
17067
18127
|
* @description Tapkey access group reference.
|
|
17068
18128
|
*/
|
|
17069
18129
|
tapkeyGroupRef?: string;
|
|
18130
|
+
/** @description UniFi Access policy reference. */
|
|
18131
|
+
unifiAccessGroupRef?: string;
|
|
17070
18132
|
};
|
|
17071
18133
|
/**
|
|
17072
18134
|
* @description Addons included in the plan.
|
|
@@ -17264,6 +18326,8 @@ interface components {
|
|
|
17264
18326
|
* @description Tapkey access group reference.
|
|
17265
18327
|
*/
|
|
17266
18328
|
tapkeyGroupRef?: string | null;
|
|
18329
|
+
/** @description UniFi Access policy reference. */
|
|
18330
|
+
unifiAccessGroupRef?: string | null;
|
|
17267
18331
|
};
|
|
17268
18332
|
/** @description Addons included in the plan. */
|
|
17269
18333
|
addons?: {
|
|
@@ -17403,6 +18467,11 @@ interface components {
|
|
|
17403
18467
|
bookingStepMinutes?: number;
|
|
17404
18468
|
/** @description Brivo access group reference. */
|
|
17405
18469
|
brivoGroupRef?: number | null;
|
|
18470
|
+
/**
|
|
18471
|
+
* @description Buffer time blocked before each booking.
|
|
18472
|
+
* @enum {string}
|
|
18473
|
+
*/
|
|
18474
|
+
bufferTime?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
17406
18475
|
/** @description Maximum capacity per booking. */
|
|
17407
18476
|
capacity?: number | null;
|
|
17408
18477
|
/** @description Check-in settings. */
|
|
@@ -17613,7 +18682,8 @@ interface components {
|
|
|
17613
18682
|
}[];
|
|
17614
18683
|
};
|
|
17615
18684
|
/**
|
|
17616
|
-
* @
|
|
18685
|
+
* @deprecated
|
|
18686
|
+
* @description Deprecated. Use bufferTime instead.
|
|
17617
18687
|
* @enum {string}
|
|
17618
18688
|
*/
|
|
17619
18689
|
preparationMinutes?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
@@ -17703,6 +18773,8 @@ interface components {
|
|
|
17703
18773
|
* @description Tapkey access group reference.
|
|
17704
18774
|
*/
|
|
17705
18775
|
tapkeyGroupRef?: string | null;
|
|
18776
|
+
/** @description UniFi Access policy reference. */
|
|
18777
|
+
unifiAccessGroupRef?: string | null;
|
|
17706
18778
|
/** @description Display name of the resource. */
|
|
17707
18779
|
title: string;
|
|
17708
18780
|
/**
|
|
@@ -17745,6 +18817,11 @@ interface components {
|
|
|
17745
18817
|
bookingStepMinutes?: number;
|
|
17746
18818
|
/** @description Brivo access group reference. */
|
|
17747
18819
|
brivoGroupRef?: number | null;
|
|
18820
|
+
/**
|
|
18821
|
+
* @description Buffer time blocked before each booking.
|
|
18822
|
+
* @enum {string}
|
|
18823
|
+
*/
|
|
18824
|
+
bufferTime?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
17748
18825
|
/** @description Maximum capacity per booking. */
|
|
17749
18826
|
capacity?: number | null;
|
|
17750
18827
|
/** @description Check-in settings. */
|
|
@@ -17945,7 +19022,8 @@ interface components {
|
|
|
17945
19022
|
}[];
|
|
17946
19023
|
};
|
|
17947
19024
|
/**
|
|
17948
|
-
* @
|
|
19025
|
+
* @deprecated
|
|
19026
|
+
* @description Deprecated. Use bufferTime instead.
|
|
17949
19027
|
* @enum {string}
|
|
17950
19028
|
*/
|
|
17951
19029
|
preparationMinutes?: "zeroMinutes" | "fiveMinutes" | "tenMinutes" | "fifteenMinutes" | "thirtyMinutes" | "sixtyMinutes";
|
|
@@ -18035,6 +19113,8 @@ interface components {
|
|
|
18035
19113
|
* @description Tapkey access group reference.
|
|
18036
19114
|
*/
|
|
18037
19115
|
tapkeyGroupRef?: string | null;
|
|
19116
|
+
/** @description UniFi Access policy reference. */
|
|
19117
|
+
unifiAccessGroupRef?: string | null;
|
|
18038
19118
|
/** @description Display name of the resource. */
|
|
18039
19119
|
title?: string;
|
|
18040
19120
|
/**
|
|
@@ -18055,22 +19135,35 @@ interface components {
|
|
|
18055
19135
|
content: {
|
|
18056
19136
|
"application/json": {
|
|
18057
19137
|
booking: {
|
|
18058
|
-
endDate: components["schemas"]["dateSchema"];
|
|
18059
|
-
memo?: string;
|
|
18060
19138
|
/**
|
|
18061
|
-
* Format:
|
|
18062
|
-
* @description
|
|
19139
|
+
* Format: date-time
|
|
19140
|
+
* @description ISO timestamp when the booking ends.
|
|
18063
19141
|
*/
|
|
18064
|
-
|
|
18065
|
-
|
|
18066
|
-
|
|
19142
|
+
endDate: string;
|
|
19143
|
+
/** @description Set to true to book the entire resource instead of individual seats. Supported for office resources. */
|
|
19144
|
+
entire?: boolean;
|
|
18067
19145
|
/**
|
|
18068
19146
|
* Format: uuid
|
|
18069
|
-
* @
|
|
19147
|
+
* @deprecated
|
|
19148
|
+
* @description Membership id to book on behalf of. Defaults to the authenticated user's membership.
|
|
18070
19149
|
*/
|
|
18071
19150
|
membershipRefOwner?: string;
|
|
19151
|
+
/** @description Internal note attached to the booking. */
|
|
19152
|
+
memo?: string;
|
|
19153
|
+
/**
|
|
19154
|
+
* Format: uuid
|
|
19155
|
+
* @description ID of the resource to book.
|
|
19156
|
+
*/
|
|
19157
|
+
resourceRef: string;
|
|
18072
19158
|
/** @description Number of seats to reserve. Required for desk and office resources. */
|
|
18073
19159
|
seats?: number;
|
|
19160
|
+
/**
|
|
19161
|
+
* Format: date-time
|
|
19162
|
+
* @description ISO timestamp when the booking starts.
|
|
19163
|
+
*/
|
|
19164
|
+
startDate: string;
|
|
19165
|
+
/** @description Custom title for the booking. */
|
|
19166
|
+
title?: string;
|
|
18074
19167
|
};
|
|
18075
19168
|
};
|
|
18076
19169
|
};
|
|
@@ -18561,6 +19654,8 @@ interface components {
|
|
|
18561
19654
|
* @enum {string}
|
|
18562
19655
|
*/
|
|
18563
19656
|
type?: "oneOff" | "recurring";
|
|
19657
|
+
/** @description UniFi Access policy reference. */
|
|
19658
|
+
unifiAccessGroupRef?: string | null;
|
|
18564
19659
|
}[];
|
|
18565
19660
|
/**
|
|
18566
19661
|
* @description Billing period.
|
|
@@ -18753,6 +19848,8 @@ interface components {
|
|
|
18753
19848
|
* @enum {string}
|
|
18754
19849
|
*/
|
|
18755
19850
|
type?: "oneOff" | "recurring";
|
|
19851
|
+
/** @description UniFi Access policy reference. */
|
|
19852
|
+
unifiAccessGroupRef?: string | null;
|
|
18756
19853
|
/**
|
|
18757
19854
|
* Format: uuid
|
|
18758
19855
|
* @description Unique identifier of the subscription item when updating via subscription patch.
|
|
@@ -18944,6 +20041,8 @@ interface components {
|
|
|
18944
20041
|
* @enum {string}
|
|
18945
20042
|
*/
|
|
18946
20043
|
type?: "oneOff" | "recurring";
|
|
20044
|
+
/** @description UniFi Access policy reference. */
|
|
20045
|
+
unifiAccessGroupRef?: string | null;
|
|
18947
20046
|
};
|
|
18948
20047
|
};
|
|
18949
20048
|
};
|
|
@@ -19094,6 +20193,8 @@ interface components {
|
|
|
19094
20193
|
* @enum {string}
|
|
19095
20194
|
*/
|
|
19096
20195
|
type?: "oneOff" | "recurring";
|
|
20196
|
+
/** @description UniFi Access policy reference. */
|
|
20197
|
+
unifiAccessGroupRef?: string | null;
|
|
19097
20198
|
};
|
|
19098
20199
|
};
|
|
19099
20200
|
};
|
|
@@ -24118,14 +25219,14 @@ interface operations {
|
|
|
24118
25219
|
getResources: {
|
|
24119
25220
|
parameters: {
|
|
24120
25221
|
query: {
|
|
24121
|
-
/** @description
|
|
24122
|
-
locationRef: string;
|
|
24123
|
-
/** @description The types of resources to retrieve. Pass them as comma separated values. */
|
|
24124
|
-
types?: "hotDesk" | "dedicatedDesk" | "office" | "parkingLot" | "room";
|
|
24125
|
-
/** @description Token to retrieve the next page of results. */
|
|
24126
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
24127
|
-
/** @description The number of items to return. */
|
|
25222
|
+
/** @description Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
24128
25223
|
limit?: number;
|
|
25224
|
+
/** @description UUID of the location whose resources to list. */
|
|
25225
|
+
locationRef: string;
|
|
25226
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
25227
|
+
nextPageToken?: string;
|
|
25228
|
+
/** @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. */
|
|
25229
|
+
types?: string;
|
|
24129
25230
|
};
|
|
24130
25231
|
header?: {
|
|
24131
25232
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -24142,11 +25243,7 @@ interface operations {
|
|
|
24142
25243
|
[name: string]: unknown;
|
|
24143
25244
|
};
|
|
24144
25245
|
content: {
|
|
24145
|
-
"application/json":
|
|
24146
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
24147
|
-
resources?: components["schemas"]["resource"][];
|
|
24148
|
-
searchQueryNext?: components["schemas"]["searchQueryNext"];
|
|
24149
|
-
};
|
|
25246
|
+
"application/json": components["schemas"]["getResources"];
|
|
24150
25247
|
};
|
|
24151
25248
|
};
|
|
24152
25249
|
/** @description Bad Request */
|
|
@@ -24178,9 +25275,7 @@ interface operations {
|
|
|
24178
25275
|
[name: string]: unknown;
|
|
24179
25276
|
};
|
|
24180
25277
|
content: {
|
|
24181
|
-
"application/json":
|
|
24182
|
-
resource?: components["schemas"]["resource"];
|
|
24183
|
-
};
|
|
25278
|
+
"application/json": components["schemas"]["getResource"];
|
|
24184
25279
|
};
|
|
24185
25280
|
};
|
|
24186
25281
|
/** @description Bad Request */
|
|
@@ -24268,10 +25363,13 @@ interface operations {
|
|
|
24268
25363
|
getResource: {
|
|
24269
25364
|
parameters: {
|
|
24270
25365
|
query?: never;
|
|
24271
|
-
header?:
|
|
25366
|
+
header?: {
|
|
25367
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25368
|
+
"spacebring-network-id"?: string;
|
|
25369
|
+
};
|
|
24272
25370
|
path: {
|
|
24273
25371
|
/** @description The id of the resource. */
|
|
24274
|
-
|
|
25372
|
+
resourceId: string;
|
|
24275
25373
|
};
|
|
24276
25374
|
cookie?: never;
|
|
24277
25375
|
};
|
|
@@ -24283,9 +25381,7 @@ interface operations {
|
|
|
24283
25381
|
[name: string]: unknown;
|
|
24284
25382
|
};
|
|
24285
25383
|
content: {
|
|
24286
|
-
"application/json":
|
|
24287
|
-
resource?: components["schemas"]["resource"];
|
|
24288
|
-
};
|
|
25384
|
+
"application/json": components["schemas"]["getResource"];
|
|
24289
25385
|
};
|
|
24290
25386
|
};
|
|
24291
25387
|
/** @description Bad Request */
|
|
@@ -24302,10 +25398,13 @@ interface operations {
|
|
|
24302
25398
|
patchResource: {
|
|
24303
25399
|
parameters: {
|
|
24304
25400
|
query?: never;
|
|
24305
|
-
header?:
|
|
25401
|
+
header?: {
|
|
25402
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25403
|
+
"spacebring-network-id"?: string;
|
|
25404
|
+
};
|
|
24306
25405
|
path: {
|
|
24307
25406
|
/** @description The id of the resource. */
|
|
24308
|
-
|
|
25407
|
+
resourceId: string;
|
|
24309
25408
|
};
|
|
24310
25409
|
cookie?: never;
|
|
24311
25410
|
};
|
|
@@ -24332,66 +25431,50 @@ interface operations {
|
|
|
24332
25431
|
getBookings: {
|
|
24333
25432
|
parameters: {
|
|
24334
25433
|
query?: {
|
|
24335
|
-
/** @description
|
|
24336
|
-
|
|
24337
|
-
/** @description
|
|
25434
|
+
/** @description Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
25435
|
+
"endDate[gt]"?: string;
|
|
25436
|
+
/** @description Matches bookings with endDate on or after this date (ISO 8601). */
|
|
25437
|
+
"endDate[gte]"?: string;
|
|
25438
|
+
/** @description Matches bookings with endDate strictly before this date (ISO 8601). */
|
|
25439
|
+
"endDate[lt]"?: string;
|
|
25440
|
+
/** @description Matches bookings with endDate on or before this date (ISO 8601). */
|
|
25441
|
+
"endDate[lte]"?: string;
|
|
25442
|
+
/** @description Matches bookings with startDate strictly after this date (ISO 8601). */
|
|
25443
|
+
"startDate[gt]"?: string;
|
|
25444
|
+
/** @description Matches bookings with startDate on or after this date (ISO 8601). */
|
|
25445
|
+
"startDate[gte]"?: string;
|
|
25446
|
+
/** @description Matches bookings with startDate strictly before this date (ISO 8601). */
|
|
25447
|
+
"startDate[lt]"?: string;
|
|
25448
|
+
/** @description Matches bookings with startDate on or before this date (ISO 8601). */
|
|
25449
|
+
"startDate[lte]"?: string;
|
|
25450
|
+
/** @description UUID of the customer whose bookings to list. */
|
|
25451
|
+
customerRef?: string;
|
|
25452
|
+
/** @description Deprecated. Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
25453
|
+
endDate?: string;
|
|
25454
|
+
/** @description Deprecated. Use status "canceled" instead. Set to "true" to include deleted bookings. */
|
|
25455
|
+
includeDeleted?: string;
|
|
25456
|
+
/** @description Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
25457
|
+
limit?: number;
|
|
25458
|
+
/** @description UUID of the location whose bookings to list. Required when resourceRef is omitted. */
|
|
24338
25459
|
locationRef?: string;
|
|
24339
|
-
/** @description
|
|
25460
|
+
/** @description Deprecated. Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
24340
25461
|
membershipRefOwner?: string;
|
|
24341
|
-
/** @description
|
|
24342
|
-
|
|
24343
|
-
|
|
24344
|
-
* Format: date-time
|
|
24345
|
-
* @description Get bookings with less or equal end date. Example: endDate[lte]=2021-05-21T10:00:00Z
|
|
24346
|
-
*/
|
|
24347
|
-
lte?: string;
|
|
24348
|
-
/**
|
|
24349
|
-
* Format: date-time
|
|
24350
|
-
* @description Get bookings with greater or equal end date. Example: endDate[gte]=2021-05-21T10:00:00Z
|
|
24351
|
-
*/
|
|
24352
|
-
gte?: string;
|
|
24353
|
-
/**
|
|
24354
|
-
* Format: date-time
|
|
24355
|
-
* @description Get bookings with less end date. Example: endDate[lt]=2021-05-21T10:00:00Z
|
|
24356
|
-
*/
|
|
24357
|
-
lt?: string;
|
|
24358
|
-
/**
|
|
24359
|
-
* Format: date-time
|
|
24360
|
-
* @description Get bookings with greater end date. Example: endDate[gt]=2021-05-21T10:00:00Z
|
|
24361
|
-
*/
|
|
24362
|
-
gt?: string;
|
|
24363
|
-
};
|
|
24364
|
-
/** @description The date filter of items. */
|
|
24365
|
-
startDate?: {
|
|
24366
|
-
/**
|
|
24367
|
-
* Format: date-time
|
|
24368
|
-
* @description Get bookings with less or equal start date. Example: startDate[lte]=2021-05-21T10:00:00Z
|
|
24369
|
-
*/
|
|
24370
|
-
lte?: string;
|
|
24371
|
-
/**
|
|
24372
|
-
* Format: date-time
|
|
24373
|
-
* @description Get bookings with greater or equal start date. Example: startDate[gte]=2021-05-21T10:00:00Z
|
|
24374
|
-
*/
|
|
24375
|
-
gte?: string;
|
|
24376
|
-
/**
|
|
24377
|
-
* Format: date-time
|
|
24378
|
-
* @description Get bookings with less start date. Example: startDate[lt]=2021-05-21T10:00:00Z
|
|
24379
|
-
*/
|
|
24380
|
-
lt?: string;
|
|
24381
|
-
/**
|
|
24382
|
-
* Format: date-time
|
|
24383
|
-
* @description Get bookings with greater start date. Example: startDate[gt]=2021-05-21T10:00:00Z
|
|
24384
|
-
*/
|
|
24385
|
-
gt?: string;
|
|
24386
|
-
};
|
|
24387
|
-
/** @description The number of items to return */
|
|
24388
|
-
limit?: number;
|
|
24389
|
-
/** @description The order of filtered items. Format - `field:order`. Possible field values are `createDate`, `endDate`, `startDate`, `id`. Order values - `asc`, `desc`. */
|
|
25462
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
25463
|
+
nextPageToken?: string;
|
|
25464
|
+
/** @description Sort order as `<field>:<direction>`, where field is startDate, endDate or createDate and direction is asc or desc. */
|
|
24390
25465
|
order?: string;
|
|
24391
|
-
/** @description
|
|
24392
|
-
|
|
24393
|
-
/** @description
|
|
24394
|
-
|
|
25466
|
+
/** @description UUID of the resource whose bookings to list. Required when locationRef is omitted. */
|
|
25467
|
+
resourceRef?: string;
|
|
25468
|
+
/** @description Set to "true" to expand repeating bookings into single occurrences. */
|
|
25469
|
+
singleBookings?: string;
|
|
25470
|
+
/** @description Deprecated. Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
25471
|
+
startDate?: string;
|
|
25472
|
+
/** @description Comma-separated list of booking statuses to filter by, e.g. `confirmed,canceled`. Valid values: tentative, confirmed, canceled. Defaults to tentative, confirmed. */
|
|
25473
|
+
status?: string;
|
|
25474
|
+
/** @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. */
|
|
25475
|
+
type?: string;
|
|
25476
|
+
/** @description Deprecated. Use type instead. */
|
|
25477
|
+
types?: string;
|
|
24395
25478
|
};
|
|
24396
25479
|
header?: {
|
|
24397
25480
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -24408,11 +25491,7 @@ interface operations {
|
|
|
24408
25491
|
[name: string]: unknown;
|
|
24409
25492
|
};
|
|
24410
25493
|
content: {
|
|
24411
|
-
"application/json":
|
|
24412
|
-
bookings?: components["schemas"]["booking"][];
|
|
24413
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
24414
|
-
searchQueryNext?: components["schemas"]["searchQueryNext"];
|
|
24415
|
-
};
|
|
25494
|
+
"application/json": components["schemas"]["getBookings"];
|
|
24416
25495
|
};
|
|
24417
25496
|
};
|
|
24418
25497
|
/** @description Bad Request */
|
|
@@ -24444,9 +25523,7 @@ interface operations {
|
|
|
24444
25523
|
[name: string]: unknown;
|
|
24445
25524
|
};
|
|
24446
25525
|
content: {
|
|
24447
|
-
"application/json":
|
|
24448
|
-
booking?: components["schemas"]["booking"];
|
|
24449
|
-
};
|
|
25526
|
+
"application/json": components["schemas"]["getBooking"];
|
|
24450
25527
|
};
|
|
24451
25528
|
};
|
|
24452
25529
|
/** @description Bad Request */
|
|
@@ -24468,8 +25545,8 @@ interface operations {
|
|
|
24468
25545
|
"spacebring-network-id"?: string;
|
|
24469
25546
|
};
|
|
24470
25547
|
path: {
|
|
24471
|
-
/** @description
|
|
24472
|
-
|
|
25548
|
+
/** @description ID of the booking. For a single occurrence of a repeating booking, append the occurrence date: `<bookingId>_<ISO date>`. */
|
|
25549
|
+
bookingId: string;
|
|
24473
25550
|
};
|
|
24474
25551
|
cookie?: never;
|
|
24475
25552
|
};
|
|
@@ -24481,9 +25558,7 @@ interface operations {
|
|
|
24481
25558
|
[name: string]: unknown;
|
|
24482
25559
|
};
|
|
24483
25560
|
content: {
|
|
24484
|
-
"application/json":
|
|
24485
|
-
booking?: components["schemas"]["booking"];
|
|
24486
|
-
};
|
|
25561
|
+
"application/json": components["schemas"]["getBooking"];
|
|
24487
25562
|
};
|
|
24488
25563
|
};
|
|
24489
25564
|
/** @description Bad Request */
|
|
@@ -24505,8 +25580,8 @@ interface operations {
|
|
|
24505
25580
|
"spacebring-network-id"?: string;
|
|
24506
25581
|
};
|
|
24507
25582
|
path: {
|
|
24508
|
-
/** @description
|
|
24509
|
-
|
|
25583
|
+
/** @description ID of the booking. For a single occurrence of a repeating booking, append the occurrence date: `<bookingId>_<ISO date>`. */
|
|
25584
|
+
bookingId: string;
|
|
24510
25585
|
};
|
|
24511
25586
|
cookie?: never;
|
|
24512
25587
|
};
|
|
@@ -26967,9 +28042,9 @@ type UpdateShopCategoryBody = NonNullable<NonNullable<operations["updateShopCate
|
|
|
26967
28042
|
/** A Assignment entity as returned by the Spacebring API. */
|
|
26968
28043
|
type Assignment = NonNullable<operations["getAssignments"]["responses"][200]["content"]["application/json"]["assignments"]>[number];
|
|
26969
28044
|
/** A Booking entity as returned by the Spacebring API. */
|
|
26970
|
-
type Booking = NonNullable<
|
|
28045
|
+
type Booking = NonNullable<operations["getBooking"]["responses"][200]["content"]["application/json"]["booking"]>;
|
|
26971
28046
|
/** A Resource entity as returned by the Spacebring API. */
|
|
26972
|
-
type Resource = NonNullable<
|
|
28047
|
+
type Resource = NonNullable<operations["getResource"]["responses"][200]["content"]["application/json"]["resource"]>;
|
|
26973
28048
|
/** Query parameters for `sb.resources.getAssignments()`. */
|
|
26974
28049
|
interface GetAssignmentsQuery {
|
|
26975
28050
|
/** UUID of the location whose resource assignments to list. */
|
|
@@ -26977,45 +28052,61 @@ interface GetAssignmentsQuery {
|
|
|
26977
28052
|
}
|
|
26978
28053
|
/** Query parameters for `sb.resources.bookings.list()`. */
|
|
26979
28054
|
interface GetBookingsQuery {
|
|
26980
|
-
/**
|
|
26981
|
-
|
|
26982
|
-
/**
|
|
28055
|
+
/** Matches bookings with endDate strictly after this date (ISO 8601). */
|
|
28056
|
+
"endDate[gt]"?: string;
|
|
28057
|
+
/** Matches bookings with endDate on or after this date (ISO 8601). */
|
|
28058
|
+
"endDate[gte]"?: string;
|
|
28059
|
+
/** Matches bookings with endDate strictly before this date (ISO 8601). */
|
|
28060
|
+
"endDate[lt]"?: string;
|
|
28061
|
+
/** Matches bookings with endDate on or before this date (ISO 8601). */
|
|
28062
|
+
"endDate[lte]"?: string;
|
|
28063
|
+
/** Matches bookings with startDate strictly after this date (ISO 8601). */
|
|
28064
|
+
"startDate[gt]"?: string;
|
|
28065
|
+
/** Matches bookings with startDate on or after this date (ISO 8601). */
|
|
28066
|
+
"startDate[gte]"?: string;
|
|
28067
|
+
/** Matches bookings with startDate strictly before this date (ISO 8601). */
|
|
28068
|
+
"startDate[lt]"?: string;
|
|
28069
|
+
/** Matches bookings with startDate on or before this date (ISO 8601). */
|
|
28070
|
+
"startDate[lte]"?: string;
|
|
28071
|
+
/** UUID of the customer whose bookings to list. */
|
|
28072
|
+
customerRef?: string;
|
|
28073
|
+
/** @deprecated Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
28074
|
+
endDate?: string;
|
|
28075
|
+
/** @deprecated Use status "canceled" instead. Set to "true" to include deleted bookings. */
|
|
28076
|
+
includeDeleted?: string;
|
|
28077
|
+
/** Maximum number of bookings per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28078
|
+
limit?: number;
|
|
28079
|
+
/** UUID of the location whose bookings to list. Required when resourceRef is omitted. */
|
|
26983
28080
|
locationRef?: string;
|
|
26984
|
-
/**
|
|
28081
|
+
/** @deprecated Use customerRef instead. UUID of the customer whose bookings to list. */
|
|
26985
28082
|
membershipRefOwner?: string;
|
|
26986
|
-
/**
|
|
26987
|
-
endDate?: {
|
|
26988
|
-
lte?: string;
|
|
26989
|
-
gte?: string;
|
|
26990
|
-
lt?: string;
|
|
26991
|
-
gt?: string;
|
|
26992
|
-
};
|
|
26993
|
-
/** The date filter of items. */
|
|
26994
|
-
startDate?: {
|
|
26995
|
-
lte?: string;
|
|
26996
|
-
gte?: string;
|
|
26997
|
-
lt?: string;
|
|
26998
|
-
gt?: string;
|
|
26999
|
-
};
|
|
27000
|
-
/** The number of items to return */
|
|
27001
|
-
limit?: number;
|
|
27002
|
-
/** The order of filtered items. Format - `field:order`. Possible field values are `createDate`, `endDate`, `startDate`, `id`. Order values - `asc`, `desc`. */
|
|
27003
|
-
order?: string;
|
|
27004
|
-
/** Token to retrieve the next page of results. */
|
|
28083
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
27005
28084
|
nextPageToken?: string;
|
|
27006
|
-
/**
|
|
27007
|
-
|
|
28085
|
+
/** Sort order as `:`, where field is startDate, endDate or createDate and direction is asc or desc. */
|
|
28086
|
+
order?: string;
|
|
28087
|
+
/** UUID of the resource whose bookings to list. Required when locationRef is omitted. */
|
|
28088
|
+
resourceRef?: string;
|
|
28089
|
+
/** Set to "true" to expand repeating bookings into single occurrences. */
|
|
28090
|
+
singleBookings?: string;
|
|
28091
|
+
/** @deprecated Use bracket-notation fields startDate[gt], startDate[gte], startDate[lt], startDate[lte] instead. */
|
|
28092
|
+
startDate?: string;
|
|
28093
|
+
/** Comma-separated list of booking statuses to filter by, e.g. `confirmed,canceled`. Valid values: tentative, confirmed, canceled. Defaults to tentative, confirmed. */
|
|
28094
|
+
status?: string;
|
|
28095
|
+
/** 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. */
|
|
28096
|
+
type?: string;
|
|
28097
|
+
/** @deprecated Use type instead. */
|
|
28098
|
+
types?: string;
|
|
27008
28099
|
}
|
|
27009
28100
|
/** Query parameters for `sb.resources.list()`. */
|
|
27010
28101
|
interface GetResourcesQuery {
|
|
27011
|
-
/**
|
|
28102
|
+
/** Maximum number of resources per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
28103
|
+
limit?: number;
|
|
28104
|
+
/** UUID of the location whose resources to list. */
|
|
27012
28105
|
locationRef: string;
|
|
27013
|
-
/**
|
|
27014
|
-
types?: "hotDesk" | "dedicatedDesk" | "office" | "parkingLot" | "room";
|
|
27015
|
-
/** Token to retrieve the next page of results. */
|
|
28106
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
27016
28107
|
nextPageToken?: string;
|
|
27017
|
-
/**
|
|
27018
|
-
|
|
28108
|
+
/** 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. */
|
|
28109
|
+
types?: string;
|
|
27019
28110
|
}
|
|
27020
28111
|
/** Request body for `sb.resources.bookings.create()`. */
|
|
27021
28112
|
type CreateBookingBody = NonNullable<NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"]["booking"]>;
|
|
@@ -27806,24 +28897,24 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
27806
28897
|
resources: {
|
|
27807
28898
|
list(query: GetResourcesQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27808
28899
|
nextPageToken?: string;
|
|
27809
|
-
resources
|
|
28900
|
+
resources: Resource[];
|
|
27810
28901
|
searchQueryNext?: string;
|
|
27811
28902
|
}>;
|
|
27812
28903
|
iterate(query: Omit<GetResourcesQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Resource, void, undefined>;
|
|
27813
|
-
get(
|
|
28904
|
+
get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
27814
28905
|
create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
27815
|
-
update(
|
|
28906
|
+
update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
27816
28907
|
getAssignments(query: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<Assignment[]>;
|
|
27817
28908
|
bookings: {
|
|
27818
28909
|
list(query?: GetBookingsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27819
|
-
bookings
|
|
28910
|
+
bookings: Booking[];
|
|
27820
28911
|
nextPageToken?: string;
|
|
27821
28912
|
searchQueryNext?: string;
|
|
27822
28913
|
}>;
|
|
27823
28914
|
iterate(query?: Omit<GetBookingsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Booking, void, undefined>;
|
|
27824
|
-
get(
|
|
28915
|
+
get(bookingId: string, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
27825
28916
|
create(booking: CreateBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
27826
|
-
delete(
|
|
28917
|
+
delete(bookingId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
27827
28918
|
};
|
|
27828
28919
|
};
|
|
27829
28920
|
shop: {
|