@izak0s/spacebring-api 10.4.0 → 10.6.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 +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +158 -7
- package/dist/index.d.ts +158 -7
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -708,7 +708,7 @@ interface paths {
|
|
|
708
708
|
};
|
|
709
709
|
/**
|
|
710
710
|
* List invoice items
|
|
711
|
-
* @description List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
711
|
+
* @description List invoice items filtered by customer, location, type, status, pending, or date range. Status and issue date filters match items connected to an invoice. Pending items are not on an invoice and not part of a subscription. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
712
712
|
*/
|
|
713
713
|
get: operations["listInvoiceItems"];
|
|
714
714
|
put?: never;
|
|
@@ -5163,6 +5163,46 @@ interface components {
|
|
|
5163
5163
|
};
|
|
5164
5164
|
/** @description ISO currency code. Reflects the alt currency when present, otherwise the base currency. */
|
|
5165
5165
|
currencyCode: string;
|
|
5166
|
+
/** @description Customer the item is billed to. */
|
|
5167
|
+
customer?: {
|
|
5168
|
+
/**
|
|
5169
|
+
* Format: uuid
|
|
5170
|
+
* @description ID of the company or membership.
|
|
5171
|
+
*/
|
|
5172
|
+
id: string;
|
|
5173
|
+
/** @description Company logo. */
|
|
5174
|
+
logo?: {
|
|
5175
|
+
key: string;
|
|
5176
|
+
url: string;
|
|
5177
|
+
};
|
|
5178
|
+
/** @description Company name. */
|
|
5179
|
+
title?: string;
|
|
5180
|
+
/**
|
|
5181
|
+
* @description Whether the customer is a company or a user.
|
|
5182
|
+
* @enum {string}
|
|
5183
|
+
*/
|
|
5184
|
+
type: "company" | "user";
|
|
5185
|
+
/** @description User details for membership customers. */
|
|
5186
|
+
user?: {
|
|
5187
|
+
/** @description User bio. */
|
|
5188
|
+
about?: string | null;
|
|
5189
|
+
/** @description User email address. */
|
|
5190
|
+
email?: string | null;
|
|
5191
|
+
/**
|
|
5192
|
+
* Format: uuid
|
|
5193
|
+
* @description User ID.
|
|
5194
|
+
*/
|
|
5195
|
+
id: string;
|
|
5196
|
+
/** @description First name. */
|
|
5197
|
+
name?: string | null;
|
|
5198
|
+
/** @description Phone number. */
|
|
5199
|
+
phoneNumber?: string | null;
|
|
5200
|
+
/** @description Profile photo URL. */
|
|
5201
|
+
photoUrl?: string | null;
|
|
5202
|
+
/** @description Last name. */
|
|
5203
|
+
surname?: string | null;
|
|
5204
|
+
};
|
|
5205
|
+
};
|
|
5166
5206
|
/**
|
|
5167
5207
|
* Format: date-time
|
|
5168
5208
|
* @description ISO timestamp of when the item was deleted.
|
|
@@ -5519,6 +5559,46 @@ interface components {
|
|
|
5519
5559
|
};
|
|
5520
5560
|
/** @description ISO currency code. Reflects the alt currency when present, otherwise the base currency. */
|
|
5521
5561
|
currencyCode: string;
|
|
5562
|
+
/** @description Customer the item is billed to. */
|
|
5563
|
+
customer?: {
|
|
5564
|
+
/**
|
|
5565
|
+
* Format: uuid
|
|
5566
|
+
* @description ID of the company or membership.
|
|
5567
|
+
*/
|
|
5568
|
+
id: string;
|
|
5569
|
+
/** @description Company logo. */
|
|
5570
|
+
logo?: {
|
|
5571
|
+
key: string;
|
|
5572
|
+
url: string;
|
|
5573
|
+
};
|
|
5574
|
+
/** @description Company name. */
|
|
5575
|
+
title?: string;
|
|
5576
|
+
/**
|
|
5577
|
+
* @description Whether the customer is a company or a user.
|
|
5578
|
+
* @enum {string}
|
|
5579
|
+
*/
|
|
5580
|
+
type: "company" | "user";
|
|
5581
|
+
/** @description User details for membership customers. */
|
|
5582
|
+
user?: {
|
|
5583
|
+
/** @description User bio. */
|
|
5584
|
+
about?: string | null;
|
|
5585
|
+
/** @description User email address. */
|
|
5586
|
+
email?: string | null;
|
|
5587
|
+
/**
|
|
5588
|
+
* Format: uuid
|
|
5589
|
+
* @description User ID.
|
|
5590
|
+
*/
|
|
5591
|
+
id: string;
|
|
5592
|
+
/** @description First name. */
|
|
5593
|
+
name?: string | null;
|
|
5594
|
+
/** @description Phone number. */
|
|
5595
|
+
phoneNumber?: string | null;
|
|
5596
|
+
/** @description Profile photo URL. */
|
|
5597
|
+
photoUrl?: string | null;
|
|
5598
|
+
/** @description Last name. */
|
|
5599
|
+
surname?: string | null;
|
|
5600
|
+
};
|
|
5601
|
+
};
|
|
5522
5602
|
/**
|
|
5523
5603
|
* Format: date-time
|
|
5524
5604
|
* @description ISO timestamp of when the item was deleted.
|
|
@@ -6751,7 +6831,10 @@ interface components {
|
|
|
6751
6831
|
locationRef?: string;
|
|
6752
6832
|
metadata?: components["schemas"]["metadata"];
|
|
6753
6833
|
notes?: string;
|
|
6754
|
-
/**
|
|
6834
|
+
/**
|
|
6835
|
+
* @description Whether the user administers the membership's location. It's read-only, as administrators are managed on the Administrators page.
|
|
6836
|
+
* @enum {string}
|
|
6837
|
+
*/
|
|
6755
6838
|
role?: "member" | "admin";
|
|
6756
6839
|
/** @enum {string} */
|
|
6757
6840
|
status?: "requested" | "approved";
|
|
@@ -9805,6 +9888,18 @@ interface components {
|
|
|
9805
9888
|
* @enum {string}
|
|
9806
9889
|
*/
|
|
9807
9890
|
bookingUnit: "hour" | "day";
|
|
9891
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
|
|
9892
|
+
bookingWindow: {
|
|
9893
|
+
/**
|
|
9894
|
+
* @description How far ahead users can book the resource.
|
|
9895
|
+
* @enum {string}
|
|
9896
|
+
*/
|
|
9897
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
9898
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
9899
|
+
enabled: boolean;
|
|
9900
|
+
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
9901
|
+
minNotice?: number;
|
|
9902
|
+
};
|
|
9808
9903
|
/** @description Brivo access group reference. */
|
|
9809
9904
|
brivoGroupRef?: number | null;
|
|
9810
9905
|
/**
|
|
@@ -10436,6 +10531,18 @@ interface components {
|
|
|
10436
10531
|
* @enum {string}
|
|
10437
10532
|
*/
|
|
10438
10533
|
bookingUnit: "hour" | "day";
|
|
10534
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
|
|
10535
|
+
bookingWindow: {
|
|
10536
|
+
/**
|
|
10537
|
+
* @description How far ahead users can book the resource.
|
|
10538
|
+
* @enum {string}
|
|
10539
|
+
*/
|
|
10540
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
10541
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
10542
|
+
enabled: boolean;
|
|
10543
|
+
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
10544
|
+
minNotice?: number;
|
|
10545
|
+
};
|
|
10439
10546
|
/** @description Brivo access group reference. */
|
|
10440
10547
|
brivoGroupRef?: number | null;
|
|
10441
10548
|
/**
|
|
@@ -11761,6 +11868,11 @@ interface components {
|
|
|
11761
11868
|
};
|
|
11762
11869
|
/** @description ID of the transaction the payment was recorded as. */
|
|
11763
11870
|
transactionRef?: string;
|
|
11871
|
+
/**
|
|
11872
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
11873
|
+
* @enum {string}
|
|
11874
|
+
*/
|
|
11875
|
+
transactionType?: "charge" | "refund";
|
|
11764
11876
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
11765
11877
|
type?: string;
|
|
11766
11878
|
};
|
|
@@ -12186,6 +12298,11 @@ interface components {
|
|
|
12186
12298
|
};
|
|
12187
12299
|
/** @description ID of the transaction the payment was recorded as. */
|
|
12188
12300
|
transactionRef?: string;
|
|
12301
|
+
/**
|
|
12302
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
12303
|
+
* @enum {string}
|
|
12304
|
+
*/
|
|
12305
|
+
transactionType?: "charge" | "refund";
|
|
12189
12306
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
12190
12307
|
type?: string;
|
|
12191
12308
|
}[];
|
|
@@ -12823,6 +12940,11 @@ interface components {
|
|
|
12823
12940
|
};
|
|
12824
12941
|
/** @description ID of the transaction the payment was recorded as. */
|
|
12825
12942
|
transactionRef?: string;
|
|
12943
|
+
/**
|
|
12944
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
12945
|
+
* @enum {string}
|
|
12946
|
+
*/
|
|
12947
|
+
transactionType?: "charge" | "refund";
|
|
12826
12948
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
12827
12949
|
type?: string;
|
|
12828
12950
|
};
|
|
@@ -13248,6 +13370,11 @@ interface components {
|
|
|
13248
13370
|
};
|
|
13249
13371
|
/** @description ID of the transaction the payment was recorded as. */
|
|
13250
13372
|
transactionRef?: string;
|
|
13373
|
+
/**
|
|
13374
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
13375
|
+
* @enum {string}
|
|
13376
|
+
*/
|
|
13377
|
+
transactionType?: "charge" | "refund";
|
|
13251
13378
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
13252
13379
|
type?: string;
|
|
13253
13380
|
}[];
|
|
@@ -22873,8 +23000,6 @@ interface components {
|
|
|
22873
23000
|
legalName?: string;
|
|
22874
23001
|
/** @description The tax id of the membership to create. */
|
|
22875
23002
|
taxId?: string;
|
|
22876
|
-
/** @enum {string} */
|
|
22877
|
-
role: "admin" | "member";
|
|
22878
23003
|
metadata?: components["schemas"]["metadata"];
|
|
22879
23004
|
notes?: string;
|
|
22880
23005
|
/**
|
|
@@ -24111,6 +24236,18 @@ interface components {
|
|
|
24111
24236
|
* @enum {string}
|
|
24112
24237
|
*/
|
|
24113
24238
|
bookingUnit?: "hour" | "day";
|
|
24239
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
|
|
24240
|
+
bookingWindow?: {
|
|
24241
|
+
/**
|
|
24242
|
+
* @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
|
|
24243
|
+
* @enum {string}
|
|
24244
|
+
*/
|
|
24245
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24246
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
24247
|
+
enabled: boolean;
|
|
24248
|
+
/** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
|
|
24249
|
+
minNotice?: number;
|
|
24250
|
+
};
|
|
24114
24251
|
/** @description Brivo access group reference. */
|
|
24115
24252
|
brivoGroupRef?: number | null;
|
|
24116
24253
|
/**
|
|
@@ -24548,6 +24685,18 @@ interface components {
|
|
|
24548
24685
|
* @enum {string}
|
|
24549
24686
|
*/
|
|
24550
24687
|
bookingUnit?: "hour" | "day";
|
|
24688
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
|
|
24689
|
+
bookingWindow?: {
|
|
24690
|
+
/**
|
|
24691
|
+
* @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
|
|
24692
|
+
* @enum {string}
|
|
24693
|
+
*/
|
|
24694
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24695
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
24696
|
+
enabled: boolean;
|
|
24697
|
+
/** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
|
|
24698
|
+
minNotice?: number;
|
|
24699
|
+
};
|
|
24551
24700
|
/** @description Brivo access group reference. */
|
|
24552
24701
|
brivoGroupRef?: number | null;
|
|
24553
24702
|
/**
|
|
@@ -25016,7 +25165,7 @@ interface components {
|
|
|
25016
25165
|
recurrence?: string[];
|
|
25017
25166
|
/**
|
|
25018
25167
|
* Format: uuid
|
|
25019
|
-
* @description ID of the resource to move the booking to. The target must belong to the same location, be of an interchangeable type, and
|
|
25168
|
+
* @description ID of the resource to move the booking to. The target must belong to the same location, be of an interchangeable type, and accept the booking's payment method. A booking paid by card or externally can't move to a resource with a lower price, and a move to a pricier one charges the difference as a separate transaction. Not supported for repeating bookings.
|
|
25020
25169
|
*/
|
|
25021
25170
|
resourceRef?: string;
|
|
25022
25171
|
/** @description Number of seats to reserve. Supported for desk and office resources. */
|
|
@@ -27660,6 +27809,8 @@ interface operations {
|
|
|
27660
27809
|
* - **voided** — cancelled and no longer valid
|
|
27661
27810
|
*/
|
|
27662
27811
|
status?: string;
|
|
27812
|
+
/** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
27813
|
+
pending?: "true" | "false";
|
|
27663
27814
|
/** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
|
|
27664
27815
|
type?: string;
|
|
27665
27816
|
};
|
|
@@ -28782,8 +28933,6 @@ interface operations {
|
|
|
28782
28933
|
};
|
|
28783
28934
|
legalName?: string;
|
|
28784
28935
|
metadata?: components["schemas"]["metadata"];
|
|
28785
|
-
/** @enum {string} */
|
|
28786
|
-
role?: "admin" | "member";
|
|
28787
28936
|
taxId?: string;
|
|
28788
28937
|
};
|
|
28789
28938
|
};
|
|
@@ -35653,6 +35802,8 @@ interface ListInvoiceItemsQuery {
|
|
|
35653
35802
|
- **paid** — fully paid
|
|
35654
35803
|
- **voided** — cancelled and no longer valid */
|
|
35655
35804
|
status?: string;
|
|
35805
|
+
/** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
35806
|
+
pending?: "true" | "false";
|
|
35656
35807
|
/** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
|
|
35657
35808
|
type?: string;
|
|
35658
35809
|
}
|
package/dist/index.d.ts
CHANGED
|
@@ -708,7 +708,7 @@ interface paths {
|
|
|
708
708
|
};
|
|
709
709
|
/**
|
|
710
710
|
* List invoice items
|
|
711
|
-
* @description List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
711
|
+
* @description List invoice items filtered by customer, location, type, status, pending, or date range. Status and issue date filters match items connected to an invoice. Pending items are not on an invoice and not part of a subscription. <h3>OAuth</h3>Required scopes: <code>invoices.readonly</code> or <code>invoices</code>
|
|
712
712
|
*/
|
|
713
713
|
get: operations["listInvoiceItems"];
|
|
714
714
|
put?: never;
|
|
@@ -5163,6 +5163,46 @@ interface components {
|
|
|
5163
5163
|
};
|
|
5164
5164
|
/** @description ISO currency code. Reflects the alt currency when present, otherwise the base currency. */
|
|
5165
5165
|
currencyCode: string;
|
|
5166
|
+
/** @description Customer the item is billed to. */
|
|
5167
|
+
customer?: {
|
|
5168
|
+
/**
|
|
5169
|
+
* Format: uuid
|
|
5170
|
+
* @description ID of the company or membership.
|
|
5171
|
+
*/
|
|
5172
|
+
id: string;
|
|
5173
|
+
/** @description Company logo. */
|
|
5174
|
+
logo?: {
|
|
5175
|
+
key: string;
|
|
5176
|
+
url: string;
|
|
5177
|
+
};
|
|
5178
|
+
/** @description Company name. */
|
|
5179
|
+
title?: string;
|
|
5180
|
+
/**
|
|
5181
|
+
* @description Whether the customer is a company or a user.
|
|
5182
|
+
* @enum {string}
|
|
5183
|
+
*/
|
|
5184
|
+
type: "company" | "user";
|
|
5185
|
+
/** @description User details for membership customers. */
|
|
5186
|
+
user?: {
|
|
5187
|
+
/** @description User bio. */
|
|
5188
|
+
about?: string | null;
|
|
5189
|
+
/** @description User email address. */
|
|
5190
|
+
email?: string | null;
|
|
5191
|
+
/**
|
|
5192
|
+
* Format: uuid
|
|
5193
|
+
* @description User ID.
|
|
5194
|
+
*/
|
|
5195
|
+
id: string;
|
|
5196
|
+
/** @description First name. */
|
|
5197
|
+
name?: string | null;
|
|
5198
|
+
/** @description Phone number. */
|
|
5199
|
+
phoneNumber?: string | null;
|
|
5200
|
+
/** @description Profile photo URL. */
|
|
5201
|
+
photoUrl?: string | null;
|
|
5202
|
+
/** @description Last name. */
|
|
5203
|
+
surname?: string | null;
|
|
5204
|
+
};
|
|
5205
|
+
};
|
|
5166
5206
|
/**
|
|
5167
5207
|
* Format: date-time
|
|
5168
5208
|
* @description ISO timestamp of when the item was deleted.
|
|
@@ -5519,6 +5559,46 @@ interface components {
|
|
|
5519
5559
|
};
|
|
5520
5560
|
/** @description ISO currency code. Reflects the alt currency when present, otherwise the base currency. */
|
|
5521
5561
|
currencyCode: string;
|
|
5562
|
+
/** @description Customer the item is billed to. */
|
|
5563
|
+
customer?: {
|
|
5564
|
+
/**
|
|
5565
|
+
* Format: uuid
|
|
5566
|
+
* @description ID of the company or membership.
|
|
5567
|
+
*/
|
|
5568
|
+
id: string;
|
|
5569
|
+
/** @description Company logo. */
|
|
5570
|
+
logo?: {
|
|
5571
|
+
key: string;
|
|
5572
|
+
url: string;
|
|
5573
|
+
};
|
|
5574
|
+
/** @description Company name. */
|
|
5575
|
+
title?: string;
|
|
5576
|
+
/**
|
|
5577
|
+
* @description Whether the customer is a company or a user.
|
|
5578
|
+
* @enum {string}
|
|
5579
|
+
*/
|
|
5580
|
+
type: "company" | "user";
|
|
5581
|
+
/** @description User details for membership customers. */
|
|
5582
|
+
user?: {
|
|
5583
|
+
/** @description User bio. */
|
|
5584
|
+
about?: string | null;
|
|
5585
|
+
/** @description User email address. */
|
|
5586
|
+
email?: string | null;
|
|
5587
|
+
/**
|
|
5588
|
+
* Format: uuid
|
|
5589
|
+
* @description User ID.
|
|
5590
|
+
*/
|
|
5591
|
+
id: string;
|
|
5592
|
+
/** @description First name. */
|
|
5593
|
+
name?: string | null;
|
|
5594
|
+
/** @description Phone number. */
|
|
5595
|
+
phoneNumber?: string | null;
|
|
5596
|
+
/** @description Profile photo URL. */
|
|
5597
|
+
photoUrl?: string | null;
|
|
5598
|
+
/** @description Last name. */
|
|
5599
|
+
surname?: string | null;
|
|
5600
|
+
};
|
|
5601
|
+
};
|
|
5522
5602
|
/**
|
|
5523
5603
|
* Format: date-time
|
|
5524
5604
|
* @description ISO timestamp of when the item was deleted.
|
|
@@ -6751,7 +6831,10 @@ interface components {
|
|
|
6751
6831
|
locationRef?: string;
|
|
6752
6832
|
metadata?: components["schemas"]["metadata"];
|
|
6753
6833
|
notes?: string;
|
|
6754
|
-
/**
|
|
6834
|
+
/**
|
|
6835
|
+
* @description Whether the user administers the membership's location. It's read-only, as administrators are managed on the Administrators page.
|
|
6836
|
+
* @enum {string}
|
|
6837
|
+
*/
|
|
6755
6838
|
role?: "member" | "admin";
|
|
6756
6839
|
/** @enum {string} */
|
|
6757
6840
|
status?: "requested" | "approved";
|
|
@@ -9805,6 +9888,18 @@ interface components {
|
|
|
9805
9888
|
* @enum {string}
|
|
9806
9889
|
*/
|
|
9807
9890
|
bookingUnit: "hour" | "day";
|
|
9891
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
|
|
9892
|
+
bookingWindow: {
|
|
9893
|
+
/**
|
|
9894
|
+
* @description How far ahead users can book the resource.
|
|
9895
|
+
* @enum {string}
|
|
9896
|
+
*/
|
|
9897
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
9898
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
9899
|
+
enabled: boolean;
|
|
9900
|
+
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
9901
|
+
minNotice?: number;
|
|
9902
|
+
};
|
|
9808
9903
|
/** @description Brivo access group reference. */
|
|
9809
9904
|
brivoGroupRef?: number | null;
|
|
9810
9905
|
/**
|
|
@@ -10436,6 +10531,18 @@ interface components {
|
|
|
10436
10531
|
* @enum {string}
|
|
10437
10532
|
*/
|
|
10438
10533
|
bookingUnit: "hour" | "day";
|
|
10534
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type. */
|
|
10535
|
+
bookingWindow: {
|
|
10536
|
+
/**
|
|
10537
|
+
* @description How far ahead users can book the resource.
|
|
10538
|
+
* @enum {string}
|
|
10539
|
+
*/
|
|
10540
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
10541
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
10542
|
+
enabled: boolean;
|
|
10543
|
+
/** @description How many minutes before it starts a booking of the resource has to be made. */
|
|
10544
|
+
minNotice?: number;
|
|
10545
|
+
};
|
|
10439
10546
|
/** @description Brivo access group reference. */
|
|
10440
10547
|
brivoGroupRef?: number | null;
|
|
10441
10548
|
/**
|
|
@@ -11761,6 +11868,11 @@ interface components {
|
|
|
11761
11868
|
};
|
|
11762
11869
|
/** @description ID of the transaction the payment was recorded as. */
|
|
11763
11870
|
transactionRef?: string;
|
|
11871
|
+
/**
|
|
11872
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
11873
|
+
* @enum {string}
|
|
11874
|
+
*/
|
|
11875
|
+
transactionType?: "charge" | "refund";
|
|
11764
11876
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
11765
11877
|
type?: string;
|
|
11766
11878
|
};
|
|
@@ -12186,6 +12298,11 @@ interface components {
|
|
|
12186
12298
|
};
|
|
12187
12299
|
/** @description ID of the transaction the payment was recorded as. */
|
|
12188
12300
|
transactionRef?: string;
|
|
12301
|
+
/**
|
|
12302
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
12303
|
+
* @enum {string}
|
|
12304
|
+
*/
|
|
12305
|
+
transactionType?: "charge" | "refund";
|
|
12189
12306
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
12190
12307
|
type?: string;
|
|
12191
12308
|
}[];
|
|
@@ -12823,6 +12940,11 @@ interface components {
|
|
|
12823
12940
|
};
|
|
12824
12941
|
/** @description ID of the transaction the payment was recorded as. */
|
|
12825
12942
|
transactionRef?: string;
|
|
12943
|
+
/**
|
|
12944
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
12945
|
+
* @enum {string}
|
|
12946
|
+
*/
|
|
12947
|
+
transactionType?: "charge" | "refund";
|
|
12826
12948
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
12827
12949
|
type?: string;
|
|
12828
12950
|
};
|
|
@@ -13248,6 +13370,11 @@ interface components {
|
|
|
13248
13370
|
};
|
|
13249
13371
|
/** @description ID of the transaction the payment was recorded as. */
|
|
13250
13372
|
transactionRef?: string;
|
|
13373
|
+
/**
|
|
13374
|
+
* @description Whether the transaction took the `price` from the payer or gave it back, as when a booking paid with credits or day passes is shortened. `price` is always positive, so a `refund` subtracts from what the booking cost.
|
|
13375
|
+
* @enum {string}
|
|
13376
|
+
*/
|
|
13377
|
+
transactionType?: "charge" | "refund";
|
|
13251
13378
|
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
13252
13379
|
type?: string;
|
|
13253
13380
|
}[];
|
|
@@ -22873,8 +23000,6 @@ interface components {
|
|
|
22873
23000
|
legalName?: string;
|
|
22874
23001
|
/** @description The tax id of the membership to create. */
|
|
22875
23002
|
taxId?: string;
|
|
22876
|
-
/** @enum {string} */
|
|
22877
|
-
role: "admin" | "member";
|
|
22878
23003
|
metadata?: components["schemas"]["metadata"];
|
|
22879
23004
|
notes?: string;
|
|
22880
23005
|
/**
|
|
@@ -24111,6 +24236,18 @@ interface components {
|
|
|
24111
24236
|
* @enum {string}
|
|
24112
24237
|
*/
|
|
24113
24238
|
bookingUnit?: "hour" | "day";
|
|
24239
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
|
|
24240
|
+
bookingWindow?: {
|
|
24241
|
+
/**
|
|
24242
|
+
* @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
|
|
24243
|
+
* @enum {string}
|
|
24244
|
+
*/
|
|
24245
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24246
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
24247
|
+
enabled: boolean;
|
|
24248
|
+
/** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
|
|
24249
|
+
minNotice?: number;
|
|
24250
|
+
};
|
|
24114
24251
|
/** @description Brivo access group reference. */
|
|
24115
24252
|
brivoGroupRef?: number | null;
|
|
24116
24253
|
/**
|
|
@@ -24548,6 +24685,18 @@ interface components {
|
|
|
24548
24685
|
* @enum {string}
|
|
24549
24686
|
*/
|
|
24550
24687
|
bookingUnit?: "hour" | "day";
|
|
24688
|
+
/** @description How soon and how far ahead users can book this resource. While enabled is false, the resource follows the booking window its location sets for the resource type and keeps its own values for when it is enabled again. Administrators are not limited by either. */
|
|
24689
|
+
bookingWindow?: {
|
|
24690
|
+
/**
|
|
24691
|
+
* @description How far ahead users can book the resource, the same values the location takes. Required while enabled is true.
|
|
24692
|
+
* @enum {string}
|
|
24693
|
+
*/
|
|
24694
|
+
bookAhead?: "oneDay" | "twoDays" | "oneWeek" | "twoWeeks" | "oneMonth" | "threeMonths" | "sixMonths" | "oneYear" | "unlimited";
|
|
24695
|
+
/** @description Whether the resource uses this booking window instead of the one its location sets for the resource type. */
|
|
24696
|
+
enabled: boolean;
|
|
24697
|
+
/** @description How many minutes before it starts a booking of the resource has to be made, up to 30 days. 0 accepts bookings up to the start time. Required while enabled is true. */
|
|
24698
|
+
minNotice?: number;
|
|
24699
|
+
};
|
|
24551
24700
|
/** @description Brivo access group reference. */
|
|
24552
24701
|
brivoGroupRef?: number | null;
|
|
24553
24702
|
/**
|
|
@@ -25016,7 +25165,7 @@ interface components {
|
|
|
25016
25165
|
recurrence?: string[];
|
|
25017
25166
|
/**
|
|
25018
25167
|
* Format: uuid
|
|
25019
|
-
* @description ID of the resource to move the booking to. The target must belong to the same location, be of an interchangeable type, and
|
|
25168
|
+
* @description ID of the resource to move the booking to. The target must belong to the same location, be of an interchangeable type, and accept the booking's payment method. A booking paid by card or externally can't move to a resource with a lower price, and a move to a pricier one charges the difference as a separate transaction. Not supported for repeating bookings.
|
|
25020
25169
|
*/
|
|
25021
25170
|
resourceRef?: string;
|
|
25022
25171
|
/** @description Number of seats to reserve. Supported for desk and office resources. */
|
|
@@ -27660,6 +27809,8 @@ interface operations {
|
|
|
27660
27809
|
* - **voided** — cancelled and no longer valid
|
|
27661
27810
|
*/
|
|
27662
27811
|
status?: string;
|
|
27812
|
+
/** @description Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
27813
|
+
pending?: "true" | "false";
|
|
27663
27814
|
/** @description Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
|
|
27664
27815
|
type?: string;
|
|
27665
27816
|
};
|
|
@@ -28782,8 +28933,6 @@ interface operations {
|
|
|
28782
28933
|
};
|
|
28783
28934
|
legalName?: string;
|
|
28784
28935
|
metadata?: components["schemas"]["metadata"];
|
|
28785
|
-
/** @enum {string} */
|
|
28786
|
-
role?: "admin" | "member";
|
|
28787
28936
|
taxId?: string;
|
|
28788
28937
|
};
|
|
28789
28938
|
};
|
|
@@ -35653,6 +35802,8 @@ interface ListInvoiceItemsQuery {
|
|
|
35653
35802
|
- **paid** — fully paid
|
|
35654
35803
|
- **voided** — cancelled and no longer valid */
|
|
35655
35804
|
status?: string;
|
|
35805
|
+
/** Filter by whether the item is pending: not on an invoice and not part of a subscription. Pass true or false. */
|
|
35806
|
+
pending?: "true" | "false";
|
|
35656
35807
|
/** Filter by invoice item type. Comma-separated values, e.g. `custom,order`. */
|
|
35657
35808
|
type?: string;
|
|
35658
35809
|
}
|
package/dist/index.js
CHANGED
|
@@ -964,7 +964,7 @@ function createBilling(client, defaults) {
|
|
|
964
964
|
/**
|
|
965
965
|
* List invoice items
|
|
966
966
|
*
|
|
967
|
-
* List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice.
|
|
967
|
+
* List invoice items filtered by customer, location, type, status, pending, or date range. Status and issue date filters match items connected to an invoice. Pending items are not on an invoice and not part of a subscription.
|
|
968
968
|
*/
|
|
969
969
|
async list(query, options) {
|
|
970
970
|
return unwrap(await client.GET("/billing/invoices/v1/items", { params: { query }, signal: options?.signal }), "GET /billing/invoices/v1/items");
|
|
@@ -972,7 +972,7 @@ function createBilling(client, defaults) {
|
|
|
972
972
|
/**
|
|
973
973
|
* List invoice items — iterates every item across all pages.
|
|
974
974
|
*
|
|
975
|
-
* List invoice items filtered customer, location, type, status, or date range. Status and issue date filters match items connected to an invoice.
|
|
975
|
+
* List invoice items filtered by customer, location, type, status, pending, or date range. Status and issue date filters match items connected to an invoice. Pending items are not on an invoice and not part of a subscription.
|
|
976
976
|
*/
|
|
977
977
|
iterate(query, options) {
|
|
978
978
|
return paginate(
|