@izak0s/spacebring-api 6.3.0 → 7.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +12 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1952 -232
- package/dist/index.d.ts +1952 -232
- package/dist/index.js +12 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2048,7 +2048,11 @@ interface paths {
|
|
|
2048
2048
|
delete: operations["deleteBooking"];
|
|
2049
2049
|
options?: never;
|
|
2050
2050
|
head?: never;
|
|
2051
|
-
|
|
2051
|
+
/**
|
|
2052
|
+
* Update a booking
|
|
2053
|
+
* @description Update a booking. Fields left out of the request keep their current value. <h3>OAuth</h3>Required scopes: <code>resources</code>
|
|
2054
|
+
*/
|
|
2055
|
+
patch: operations["patchBooking"];
|
|
2052
2056
|
trace?: never;
|
|
2053
2057
|
};
|
|
2054
2058
|
"/shop/categories/v1": {
|
|
@@ -8658,6 +8662,8 @@ interface components {
|
|
|
8658
8662
|
surname?: string | null;
|
|
8659
8663
|
};
|
|
8660
8664
|
};
|
|
8665
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
8666
|
+
endDate?: string;
|
|
8661
8667
|
/** @description Whether the assignment grants access to the entire resource. */
|
|
8662
8668
|
entire: boolean;
|
|
8663
8669
|
/**
|
|
@@ -8678,20 +8684,41 @@ interface components {
|
|
|
8678
8684
|
};
|
|
8679
8685
|
/** @description Assigned quantity when the resource is partially assigned. */
|
|
8680
8686
|
quantity?: number;
|
|
8687
|
+
/** @description Resource the assignment belongs to. Present when assignments are listed on their own. */
|
|
8688
|
+
resource?: {
|
|
8689
|
+
/**
|
|
8690
|
+
* Format: uuid
|
|
8691
|
+
* @description Resource id.
|
|
8692
|
+
*/
|
|
8693
|
+
id: string;
|
|
8694
|
+
/** @description Resource image URL. */
|
|
8695
|
+
imageUrl?: string;
|
|
8696
|
+
/**
|
|
8697
|
+
* Format: uuid
|
|
8698
|
+
* @description UUID of the location the resource belongs to.
|
|
8699
|
+
*/
|
|
8700
|
+
locationRef: string;
|
|
8701
|
+
/** @description Resource title. */
|
|
8702
|
+
title: string;
|
|
8703
|
+
/** @description Resource type. */
|
|
8704
|
+
type: string;
|
|
8705
|
+
};
|
|
8681
8706
|
/**
|
|
8682
8707
|
* Format: uuid
|
|
8683
8708
|
* @description UUID of the resource the assignment belongs to.
|
|
8684
8709
|
*/
|
|
8685
8710
|
resourceRef: string;
|
|
8686
|
-
/** @description
|
|
8711
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
8712
|
+
startDate: string;
|
|
8713
|
+
/** @description Deprecated. Use startDate and endDate instead. Subscription backing this assignment. */
|
|
8687
8714
|
subscription: {
|
|
8688
8715
|
/** @description ISO timestamp when the assignment ends. */
|
|
8689
8716
|
endDate?: string;
|
|
8690
8717
|
/**
|
|
8691
8718
|
* Format: uuid
|
|
8692
|
-
* @description Subscription id.
|
|
8719
|
+
* @description Subscription id. Absent for assignments created directly by an admin.
|
|
8693
8720
|
*/
|
|
8694
|
-
id
|
|
8721
|
+
id?: string;
|
|
8695
8722
|
/** @description ISO timestamp when the assignment starts. */
|
|
8696
8723
|
startDate: string;
|
|
8697
8724
|
};
|
|
@@ -9244,6 +9271,8 @@ interface components {
|
|
|
9244
9271
|
surname?: string | null;
|
|
9245
9272
|
};
|
|
9246
9273
|
};
|
|
9274
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
9275
|
+
endDate?: string;
|
|
9247
9276
|
/** @description Whether the assignment grants access to the entire resource. */
|
|
9248
9277
|
entire: boolean;
|
|
9249
9278
|
/**
|
|
@@ -9264,20 +9293,41 @@ interface components {
|
|
|
9264
9293
|
};
|
|
9265
9294
|
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9266
9295
|
quantity?: number;
|
|
9296
|
+
/** @description Resource the assignment belongs to. Present when assignments are listed on their own. */
|
|
9297
|
+
resource?: {
|
|
9298
|
+
/**
|
|
9299
|
+
* Format: uuid
|
|
9300
|
+
* @description Resource id.
|
|
9301
|
+
*/
|
|
9302
|
+
id: string;
|
|
9303
|
+
/** @description Resource image URL. */
|
|
9304
|
+
imageUrl?: string;
|
|
9305
|
+
/**
|
|
9306
|
+
* Format: uuid
|
|
9307
|
+
* @description UUID of the location the resource belongs to.
|
|
9308
|
+
*/
|
|
9309
|
+
locationRef: string;
|
|
9310
|
+
/** @description Resource title. */
|
|
9311
|
+
title: string;
|
|
9312
|
+
/** @description Resource type. */
|
|
9313
|
+
type: string;
|
|
9314
|
+
};
|
|
9267
9315
|
/**
|
|
9268
9316
|
* Format: uuid
|
|
9269
9317
|
* @description UUID of the resource the assignment belongs to.
|
|
9270
9318
|
*/
|
|
9271
9319
|
resourceRef: string;
|
|
9272
|
-
/** @description
|
|
9320
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
9321
|
+
startDate: string;
|
|
9322
|
+
/** @description Deprecated. Use startDate and endDate instead. Subscription backing this assignment. */
|
|
9273
9323
|
subscription: {
|
|
9274
9324
|
/** @description ISO timestamp when the assignment ends. */
|
|
9275
9325
|
endDate?: string;
|
|
9276
9326
|
/**
|
|
9277
9327
|
* Format: uuid
|
|
9278
|
-
* @description Subscription id.
|
|
9328
|
+
* @description Subscription id. Absent for assignments created directly by an admin.
|
|
9279
9329
|
*/
|
|
9280
|
-
id
|
|
9330
|
+
id?: string;
|
|
9281
9331
|
/** @description ISO timestamp when the assignment starts. */
|
|
9282
9332
|
startDate: string;
|
|
9283
9333
|
};
|
|
@@ -9826,6 +9876,8 @@ interface components {
|
|
|
9826
9876
|
surname?: string | null;
|
|
9827
9877
|
};
|
|
9828
9878
|
};
|
|
9879
|
+
/** @description ISO timestamp when the assignment ends. */
|
|
9880
|
+
endDate?: string;
|
|
9829
9881
|
/** @description Whether the assignment grants access to the entire resource. */
|
|
9830
9882
|
entire: boolean;
|
|
9831
9883
|
/**
|
|
@@ -9846,20 +9898,41 @@ interface components {
|
|
|
9846
9898
|
};
|
|
9847
9899
|
/** @description Assigned quantity when the resource is partially assigned. */
|
|
9848
9900
|
quantity?: number;
|
|
9901
|
+
/** @description Resource the assignment belongs to. Present when assignments are listed on their own. */
|
|
9902
|
+
resource?: {
|
|
9903
|
+
/**
|
|
9904
|
+
* Format: uuid
|
|
9905
|
+
* @description Resource id.
|
|
9906
|
+
*/
|
|
9907
|
+
id: string;
|
|
9908
|
+
/** @description Resource image URL. */
|
|
9909
|
+
imageUrl?: string;
|
|
9910
|
+
/**
|
|
9911
|
+
* Format: uuid
|
|
9912
|
+
* @description UUID of the location the resource belongs to.
|
|
9913
|
+
*/
|
|
9914
|
+
locationRef: string;
|
|
9915
|
+
/** @description Resource title. */
|
|
9916
|
+
title: string;
|
|
9917
|
+
/** @description Resource type. */
|
|
9918
|
+
type: string;
|
|
9919
|
+
};
|
|
9849
9920
|
/**
|
|
9850
9921
|
* Format: uuid
|
|
9851
9922
|
* @description UUID of the resource the assignment belongs to.
|
|
9852
9923
|
*/
|
|
9853
9924
|
resourceRef: string;
|
|
9854
|
-
/** @description
|
|
9925
|
+
/** @description ISO timestamp when the assignment starts. */
|
|
9926
|
+
startDate: string;
|
|
9927
|
+
/** @description Deprecated. Use startDate and endDate instead. Subscription backing this assignment. */
|
|
9855
9928
|
subscription: {
|
|
9856
9929
|
/** @description ISO timestamp when the assignment ends. */
|
|
9857
9930
|
endDate?: string;
|
|
9858
9931
|
/**
|
|
9859
9932
|
* Format: uuid
|
|
9860
|
-
* @description Subscription id.
|
|
9933
|
+
* @description Subscription id. Absent for assignments created directly by an admin.
|
|
9861
9934
|
*/
|
|
9862
|
-
id
|
|
9935
|
+
id?: string;
|
|
9863
9936
|
/** @description ISO timestamp when the assignment starts. */
|
|
9864
9937
|
startDate: string;
|
|
9865
9938
|
};
|
|
@@ -9953,248 +10026,1804 @@ interface components {
|
|
|
9953
10026
|
* @description Deprecated. Use `payments` instead.
|
|
9954
10027
|
*/
|
|
9955
10028
|
payment?: {
|
|
9956
|
-
/** @description Payment amount in the location currency. */
|
|
9957
|
-
amount?: number;
|
|
9958
|
-
/** @description ISO 4217 currency code. */
|
|
9959
|
-
currencyCode?: string;
|
|
9960
|
-
/** @description ID of the associated invoice item. */
|
|
9961
|
-
invoiceItemRef?: string;
|
|
9962
10029
|
/**
|
|
9963
|
-
*
|
|
9964
|
-
* @
|
|
10030
|
+
* Format: date-time
|
|
10031
|
+
* @description ISO timestamp of when the payment was made.
|
|
9965
10032
|
*/
|
|
9966
|
-
|
|
9967
|
-
/** @description
|
|
9968
|
-
|
|
9969
|
-
|
|
9970
|
-
|
|
9971
|
-
amount
|
|
10033
|
+
createDate?: string;
|
|
10034
|
+
/** @description Discounts applied to the price. Omitted when none applied. */
|
|
10035
|
+
discounts?: {
|
|
10036
|
+
/** @description Applied coupon. */
|
|
10037
|
+
coupon: {
|
|
10038
|
+
/** @description Fixed discount amount, in the coupon's currency. */
|
|
10039
|
+
amountOff?: number;
|
|
10040
|
+
/** @description Currency code for amountOff. */
|
|
10041
|
+
currencyCode?: string;
|
|
10042
|
+
/** @description Coupon id. */
|
|
10043
|
+
id?: string;
|
|
10044
|
+
/** @description Percentage discount amount. */
|
|
10045
|
+
percentOff?: number;
|
|
10046
|
+
/** @description Product types this coupon applies to. */
|
|
10047
|
+
productTypes?: string[];
|
|
10048
|
+
/** @description Coupon type. */
|
|
10049
|
+
type?: string;
|
|
10050
|
+
};
|
|
10051
|
+
/** @description Applied promocode. */
|
|
10052
|
+
promocode?: {
|
|
10053
|
+
/** @description Promocode string, the way a purchase references the promocode back. */
|
|
10054
|
+
code: string;
|
|
10055
|
+
/** @description Promocode expiration. */
|
|
10056
|
+
expiration?: {
|
|
10057
|
+
/** @description ISO timestamp of when the promocode expires. */
|
|
10058
|
+
date?: string;
|
|
10059
|
+
/** @description Whether the promocode expires. */
|
|
10060
|
+
enabled: boolean;
|
|
10061
|
+
};
|
|
10062
|
+
/** @description Promocode id. */
|
|
10063
|
+
id: string;
|
|
10064
|
+
/** @description Whether the promocode is limited to a first purchase. */
|
|
10065
|
+
limitByFirstPurchase?: boolean;
|
|
10066
|
+
};
|
|
10067
|
+
/** @description Subscription the discount was granted by. */
|
|
10068
|
+
subscriptionId?: string;
|
|
10069
|
+
}[];
|
|
10070
|
+
/** @description Chargeback dispute raised against the payment, if any. */
|
|
10071
|
+
dispute?: {
|
|
10072
|
+
/**
|
|
10073
|
+
* Format: date-time
|
|
10074
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
10075
|
+
*/
|
|
10076
|
+
createDate?: string;
|
|
10077
|
+
};
|
|
10078
|
+
/** @description How the booking was paid for, and by whom. */
|
|
10079
|
+
method: {
|
|
10080
|
+
/** @description Set when `type` is `credits`. */
|
|
10081
|
+
credits?: {
|
|
10082
|
+
/** @description Customer whose credits were spent. */
|
|
10083
|
+
customer: {
|
|
10084
|
+
/**
|
|
10085
|
+
* Format: uuid
|
|
10086
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10087
|
+
*/
|
|
10088
|
+
id?: string;
|
|
10089
|
+
/** @description Location the payer belongs to. */
|
|
10090
|
+
location?: {
|
|
10091
|
+
/**
|
|
10092
|
+
* Format: uuid
|
|
10093
|
+
* @description Location id.
|
|
10094
|
+
*/
|
|
10095
|
+
id: string;
|
|
10096
|
+
/** @description Location display name. */
|
|
10097
|
+
title?: string;
|
|
10098
|
+
};
|
|
10099
|
+
/** @description First name. Present for `user` payers. */
|
|
10100
|
+
name?: string | null;
|
|
10101
|
+
/** @description Last name. Present for `user` payers. */
|
|
10102
|
+
surname?: string | null;
|
|
10103
|
+
/** @description Company name. Present for `company` payers. */
|
|
10104
|
+
title?: string;
|
|
10105
|
+
/**
|
|
10106
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10107
|
+
* @enum {string}
|
|
10108
|
+
*/
|
|
10109
|
+
type: "company" | "user";
|
|
10110
|
+
};
|
|
10111
|
+
};
|
|
10112
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
10113
|
+
dayPasses?: {
|
|
10114
|
+
/** @description Customer whose day passes were spent. */
|
|
10115
|
+
customer: {
|
|
10116
|
+
/**
|
|
10117
|
+
* Format: uuid
|
|
10118
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10119
|
+
*/
|
|
10120
|
+
id?: string;
|
|
10121
|
+
/** @description Location the payer belongs to. */
|
|
10122
|
+
location?: {
|
|
10123
|
+
/**
|
|
10124
|
+
* Format: uuid
|
|
10125
|
+
* @description Location id.
|
|
10126
|
+
*/
|
|
10127
|
+
id: string;
|
|
10128
|
+
/** @description Location display name. */
|
|
10129
|
+
title?: string;
|
|
10130
|
+
};
|
|
10131
|
+
/** @description First name. Present for `user` payers. */
|
|
10132
|
+
name?: string | null;
|
|
10133
|
+
/** @description Last name. Present for `user` payers. */
|
|
10134
|
+
surname?: string | null;
|
|
10135
|
+
/** @description Company name. Present for `company` payers. */
|
|
10136
|
+
title?: string;
|
|
10137
|
+
/**
|
|
10138
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10139
|
+
* @enum {string}
|
|
10140
|
+
*/
|
|
10141
|
+
type: "company" | "user";
|
|
10142
|
+
};
|
|
10143
|
+
};
|
|
10144
|
+
/** @description Set when `type` is `external`. */
|
|
10145
|
+
external?: {
|
|
10146
|
+
/** @description Customer who paid outside of Spacebring. */
|
|
10147
|
+
customer: {
|
|
10148
|
+
/**
|
|
10149
|
+
* Format: uuid
|
|
10150
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10151
|
+
*/
|
|
10152
|
+
id?: string;
|
|
10153
|
+
/** @description Location the payer belongs to. */
|
|
10154
|
+
location?: {
|
|
10155
|
+
/**
|
|
10156
|
+
* Format: uuid
|
|
10157
|
+
* @description Location id.
|
|
10158
|
+
*/
|
|
10159
|
+
id: string;
|
|
10160
|
+
/** @description Location display name. */
|
|
10161
|
+
title?: string;
|
|
10162
|
+
};
|
|
10163
|
+
/** @description First name. Present for `user` payers. */
|
|
10164
|
+
name?: string | null;
|
|
10165
|
+
/** @description Last name. Present for `user` payers. */
|
|
10166
|
+
surname?: string | null;
|
|
10167
|
+
/** @description Company name. Present for `company` payers. */
|
|
10168
|
+
title?: string;
|
|
10169
|
+
/**
|
|
10170
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10171
|
+
* @enum {string}
|
|
10172
|
+
*/
|
|
10173
|
+
type: "company" | "user";
|
|
10174
|
+
};
|
|
10175
|
+
};
|
|
10176
|
+
/** @description Set when `type` is `invoice`. */
|
|
10177
|
+
invoice?: {
|
|
10178
|
+
/** @description Customer the booking was invoiced to. */
|
|
10179
|
+
customer: {
|
|
10180
|
+
/**
|
|
10181
|
+
* Format: uuid
|
|
10182
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10183
|
+
*/
|
|
10184
|
+
id?: string;
|
|
10185
|
+
/** @description Location the payer belongs to. */
|
|
10186
|
+
location?: {
|
|
10187
|
+
/**
|
|
10188
|
+
* Format: uuid
|
|
10189
|
+
* @description Location id.
|
|
10190
|
+
*/
|
|
10191
|
+
id: string;
|
|
10192
|
+
/** @description Location display name. */
|
|
10193
|
+
title?: string;
|
|
10194
|
+
};
|
|
10195
|
+
/** @description First name. Present for `user` payers. */
|
|
10196
|
+
name?: string | null;
|
|
10197
|
+
/** @description Last name. Present for `user` payers. */
|
|
10198
|
+
surname?: string | null;
|
|
10199
|
+
/** @description Company name. Present for `company` payers. */
|
|
10200
|
+
title?: string;
|
|
10201
|
+
/**
|
|
10202
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10203
|
+
* @enum {string}
|
|
10204
|
+
*/
|
|
10205
|
+
type: "company" | "user";
|
|
10206
|
+
};
|
|
10207
|
+
/** @description ID of the invoice item the booking was billed on. */
|
|
10208
|
+
invoiceItemRef?: string;
|
|
10209
|
+
/**
|
|
10210
|
+
* Format: uuid
|
|
10211
|
+
* @description Subscription the invoice item belongs to.
|
|
10212
|
+
*/
|
|
10213
|
+
subscriptionRef?: string;
|
|
10214
|
+
};
|
|
10215
|
+
/** @description Set when `type` is `paymentGateway`. */
|
|
10216
|
+
paymentGateway?: {
|
|
10217
|
+
/** @description Customer who was charged. */
|
|
10218
|
+
customer: {
|
|
10219
|
+
/**
|
|
10220
|
+
* Format: uuid
|
|
10221
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10222
|
+
*/
|
|
10223
|
+
id?: string;
|
|
10224
|
+
/** @description Location the payer belongs to. */
|
|
10225
|
+
location?: {
|
|
10226
|
+
/**
|
|
10227
|
+
* Format: uuid
|
|
10228
|
+
* @description Location id.
|
|
10229
|
+
*/
|
|
10230
|
+
id: string;
|
|
10231
|
+
/** @description Location display name. */
|
|
10232
|
+
title?: string;
|
|
10233
|
+
};
|
|
10234
|
+
/** @description First name. Present for `user` payers. */
|
|
10235
|
+
name?: string | null;
|
|
10236
|
+
/** @description Last name. Present for `user` payers. */
|
|
10237
|
+
surname?: string | null;
|
|
10238
|
+
/** @description Company name. Present for `company` payers. */
|
|
10239
|
+
title?: string;
|
|
10240
|
+
/**
|
|
10241
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10242
|
+
* @enum {string}
|
|
10243
|
+
*/
|
|
10244
|
+
type: "company" | "user";
|
|
10245
|
+
};
|
|
10246
|
+
/**
|
|
10247
|
+
* @description Payment gateway that processed the charge.
|
|
10248
|
+
* @enum {string}
|
|
10249
|
+
*/
|
|
10250
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
10251
|
+
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
10252
|
+
label?: string;
|
|
10253
|
+
/** @description Masked payment method identifier. */
|
|
10254
|
+
mask?: string;
|
|
10255
|
+
/** @description Display name of the payment gateway, e.g. `Stripe`. */
|
|
10256
|
+
title?: string;
|
|
10257
|
+
};
|
|
10258
|
+
/**
|
|
10259
|
+
* @description How the booking was paid for. The matching property below carries the details.
|
|
10260
|
+
* @enum {string}
|
|
10261
|
+
*/
|
|
10262
|
+
type: "credits" | "dayPasses" | "external" | "invoice" | "paymentGateway";
|
|
10263
|
+
};
|
|
10264
|
+
/** @description What the booking was charged. */
|
|
10265
|
+
price?: {
|
|
10266
|
+
/** @description Set when `type` is `credits`. */
|
|
10267
|
+
credits?: {
|
|
10268
|
+
/** @description Expiring credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
10269
|
+
expiringAmount?: number;
|
|
10270
|
+
/** @description Permanent credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
10271
|
+
permanentAmount?: number;
|
|
10272
|
+
/** @description Total credits charged. */
|
|
10273
|
+
totalAmount: number;
|
|
10274
|
+
};
|
|
10275
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
10276
|
+
dayPasses?: {
|
|
10277
|
+
/** @description Expiring day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
10278
|
+
expiringAmount?: number;
|
|
10279
|
+
/** @description Permanent day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
10280
|
+
permanentAmount?: number;
|
|
10281
|
+
/** @description Total day passes charged. */
|
|
10282
|
+
totalAmount: number;
|
|
10283
|
+
};
|
|
10284
|
+
/** @description Set when `type` is `money`. */
|
|
10285
|
+
money?: {
|
|
9972
10286
|
/** @description ISO 4217 currency code. */
|
|
9973
10287
|
currencyCode?: string;
|
|
9974
|
-
/** @description
|
|
9975
|
-
|
|
9976
|
-
/** @description
|
|
9977
|
-
|
|
10288
|
+
/** @description Total amount charged, tax included. */
|
|
10289
|
+
grossAmount: number;
|
|
10290
|
+
/** @description Whether the resource price already contained the tax, rather than the tax being added on top of it. Together with `taxRate` it is what splits `grossAmount` into its net and tax parts. Omitted when the location charges no tax. */
|
|
10291
|
+
taxIsInclusive?: boolean;
|
|
10292
|
+
/** @description Tax rate applied, in percent. Omitted when the location charges no tax. */
|
|
10293
|
+
taxRate?: number;
|
|
9978
10294
|
};
|
|
9979
10295
|
/**
|
|
9980
|
-
* @description
|
|
10296
|
+
* @description What the booking was charged in.
|
|
9981
10297
|
* @enum {string}
|
|
9982
10298
|
*/
|
|
9983
|
-
type: "money";
|
|
10299
|
+
type: "credits" | "dayPasses" | "money";
|
|
9984
10300
|
};
|
|
9985
|
-
/** @description
|
|
9986
|
-
|
|
9987
|
-
/** @description
|
|
9988
|
-
|
|
9989
|
-
|
|
9990
|
-
|
|
9991
|
-
|
|
9992
|
-
|
|
9993
|
-
|
|
9994
|
-
|
|
9995
|
-
|
|
9996
|
-
|
|
9997
|
-
|
|
9998
|
-
|
|
9999
|
-
|
|
10000
|
-
|
|
10001
|
-
|
|
10002
|
-
|
|
10003
|
-
|
|
10004
|
-
|
|
10005
|
-
|
|
10006
|
-
|
|
10007
|
-
|
|
10301
|
+
/** @description Whether the payment can still be refunded. Omitted for `invoice` payments, where refundability depends on the invoice. */
|
|
10302
|
+
refundable?: boolean;
|
|
10303
|
+
/** @description Refunds made against the payment. Omitted when nothing was refunded. */
|
|
10304
|
+
refunds?: {
|
|
10305
|
+
/** @description Set when `type` is `credits`. */
|
|
10306
|
+
credits?: {
|
|
10307
|
+
/**
|
|
10308
|
+
* @deprecated
|
|
10309
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
10310
|
+
*/
|
|
10311
|
+
amountExpiring: number;
|
|
10312
|
+
/**
|
|
10313
|
+
* @deprecated
|
|
10314
|
+
* @description Deprecated. Use `amounts` instead.
|
|
10315
|
+
*/
|
|
10316
|
+
amountPermanent: number;
|
|
10317
|
+
/** @description Total amount returned by this refund. */
|
|
10318
|
+
amountTotal: number;
|
|
10319
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
10320
|
+
amounts?: {
|
|
10321
|
+
/** @description Amount returned to this balance bucket. */
|
|
10322
|
+
amount: number;
|
|
10323
|
+
/**
|
|
10324
|
+
* Format: date-time
|
|
10325
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
10326
|
+
*/
|
|
10327
|
+
expirationDate?: string;
|
|
10328
|
+
/**
|
|
10329
|
+
* Format: uuid
|
|
10330
|
+
* @description Subscription the expiring balance belongs to.
|
|
10331
|
+
*/
|
|
10332
|
+
subscriptionRef?: string;
|
|
10333
|
+
/**
|
|
10334
|
+
* @description Balance bucket type.
|
|
10335
|
+
* @enum {string}
|
|
10336
|
+
*/
|
|
10337
|
+
type: "expiring" | "permanent";
|
|
10338
|
+
}[];
|
|
10339
|
+
/**
|
|
10340
|
+
* Format: date-time
|
|
10341
|
+
* @description ISO timestamp of when the refund was made.
|
|
10342
|
+
*/
|
|
10343
|
+
createDate?: string;
|
|
10344
|
+
/** @description Refund transaction id. */
|
|
10345
|
+
id?: string;
|
|
10346
|
+
}[];
|
|
10347
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
10348
|
+
dayPasses?: {
|
|
10349
|
+
/**
|
|
10350
|
+
* @deprecated
|
|
10351
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
10352
|
+
*/
|
|
10353
|
+
amountExpiring: number;
|
|
10354
|
+
/**
|
|
10355
|
+
* @deprecated
|
|
10356
|
+
* @description Deprecated. Use `amounts` instead.
|
|
10357
|
+
*/
|
|
10358
|
+
amountPermanent: number;
|
|
10359
|
+
/** @description Total amount returned by this refund. */
|
|
10360
|
+
amountTotal: number;
|
|
10361
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
10362
|
+
amounts?: {
|
|
10363
|
+
/** @description Amount returned to this balance bucket. */
|
|
10364
|
+
amount: number;
|
|
10365
|
+
/**
|
|
10366
|
+
* Format: date-time
|
|
10367
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
10368
|
+
*/
|
|
10369
|
+
expirationDate?: string;
|
|
10370
|
+
/**
|
|
10371
|
+
* Format: uuid
|
|
10372
|
+
* @description Subscription the expiring balance belongs to.
|
|
10373
|
+
*/
|
|
10374
|
+
subscriptionRef?: string;
|
|
10375
|
+
/**
|
|
10376
|
+
* @description Balance bucket type.
|
|
10377
|
+
* @enum {string}
|
|
10378
|
+
*/
|
|
10379
|
+
type: "expiring" | "permanent";
|
|
10380
|
+
}[];
|
|
10381
|
+
/**
|
|
10382
|
+
* Format: date-time
|
|
10383
|
+
* @description ISO timestamp of when the refund was made.
|
|
10384
|
+
*/
|
|
10385
|
+
createDate?: string;
|
|
10386
|
+
/** @description Refund transaction id. */
|
|
10387
|
+
id?: string;
|
|
10388
|
+
}[];
|
|
10389
|
+
/** @description Set when `type` is `money`. */
|
|
10390
|
+
money?: {
|
|
10391
|
+
/**
|
|
10392
|
+
* Format: date-time
|
|
10393
|
+
* @description ISO timestamp of when the refund was made.
|
|
10394
|
+
*/
|
|
10395
|
+
createDate?: string;
|
|
10396
|
+
/** @description ISO 4217 currency code. */
|
|
10397
|
+
currencyCode?: string;
|
|
10398
|
+
/** @description Gross amount returned by this refund. */
|
|
10399
|
+
grossAmount: number;
|
|
10400
|
+
/** @description Refund transaction id. */
|
|
10401
|
+
id?: string;
|
|
10402
|
+
}[];
|
|
10403
|
+
/**
|
|
10404
|
+
* @description What was refunded.
|
|
10405
|
+
* @enum {string}
|
|
10406
|
+
*/
|
|
10407
|
+
type: "credits" | "dayPasses" | "money";
|
|
10408
|
+
};
|
|
10409
|
+
/** @description Set for a pending gateway payment the current user still has to complete. */
|
|
10410
|
+
request?: {
|
|
10411
|
+
/**
|
|
10412
|
+
* Format: uuid
|
|
10413
|
+
* @description Payment request id.
|
|
10414
|
+
*/
|
|
10415
|
+
id: string;
|
|
10416
|
+
/** @description Relative URL the payer opens to complete the payment. */
|
|
10417
|
+
url: string;
|
|
10418
|
+
};
|
|
10419
|
+
/**
|
|
10420
|
+
* Format: date-time
|
|
10421
|
+
* @description ISO timestamp of when a scheduled payment will be charged.
|
|
10422
|
+
*/
|
|
10423
|
+
scheduleDate?: string;
|
|
10424
|
+
/**
|
|
10425
|
+
* @description Payment status.
|
|
10426
|
+
* @enum {string}
|
|
10427
|
+
*/
|
|
10428
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10429
|
+
/** @description Surcharge added on top of the price, if any. */
|
|
10430
|
+
surcharge?: {
|
|
10431
|
+
money: {
|
|
10432
|
+
/** @description Surcharge amount. */
|
|
10433
|
+
amount?: number;
|
|
10434
|
+
/** @description ISO 4217 currency code. */
|
|
10435
|
+
currencyCode?: string;
|
|
10436
|
+
/** @description Surcharge percentage applied. */
|
|
10437
|
+
percentage?: number;
|
|
10438
|
+
/** @description Surcharge rate. */
|
|
10439
|
+
rate?: number;
|
|
10440
|
+
};
|
|
10441
|
+
/**
|
|
10442
|
+
* @description Surcharge type.
|
|
10443
|
+
* @enum {string}
|
|
10444
|
+
*/
|
|
10445
|
+
type: "money";
|
|
10446
|
+
};
|
|
10447
|
+
/** @description ID of the transaction the payment was recorded as. */
|
|
10448
|
+
transactionRef?: string;
|
|
10449
|
+
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
10450
|
+
type?: string;
|
|
10451
|
+
};
|
|
10452
|
+
/** @description How the booking was paid for, oldest first. One entry per settling transaction, so a credits or day passes payment that was charged and later partly refunded lists each transaction separately. Omitted when the caller has no access. */
|
|
10453
|
+
payments?: {
|
|
10454
|
+
/**
|
|
10455
|
+
* Format: date-time
|
|
10456
|
+
* @description ISO timestamp of when the payment was made.
|
|
10457
|
+
*/
|
|
10458
|
+
createDate?: string;
|
|
10459
|
+
/** @description Discounts applied to the price. Omitted when none applied. */
|
|
10460
|
+
discounts?: {
|
|
10461
|
+
/** @description Applied coupon. */
|
|
10462
|
+
coupon: {
|
|
10463
|
+
/** @description Fixed discount amount, in the coupon's currency. */
|
|
10464
|
+
amountOff?: number;
|
|
10465
|
+
/** @description Currency code for amountOff. */
|
|
10466
|
+
currencyCode?: string;
|
|
10467
|
+
/** @description Coupon id. */
|
|
10468
|
+
id?: string;
|
|
10469
|
+
/** @description Percentage discount amount. */
|
|
10470
|
+
percentOff?: number;
|
|
10471
|
+
/** @description Product types this coupon applies to. */
|
|
10472
|
+
productTypes?: string[];
|
|
10473
|
+
/** @description Coupon type. */
|
|
10474
|
+
type?: string;
|
|
10475
|
+
};
|
|
10476
|
+
/** @description Applied promocode. */
|
|
10477
|
+
promocode?: {
|
|
10478
|
+
/** @description Promocode string, the way a purchase references the promocode back. */
|
|
10479
|
+
code: string;
|
|
10480
|
+
/** @description Promocode expiration. */
|
|
10481
|
+
expiration?: {
|
|
10482
|
+
/** @description ISO timestamp of when the promocode expires. */
|
|
10483
|
+
date?: string;
|
|
10484
|
+
/** @description Whether the promocode expires. */
|
|
10485
|
+
enabled: boolean;
|
|
10486
|
+
};
|
|
10487
|
+
/** @description Promocode id. */
|
|
10488
|
+
id: string;
|
|
10489
|
+
/** @description Whether the promocode is limited to a first purchase. */
|
|
10490
|
+
limitByFirstPurchase?: boolean;
|
|
10491
|
+
};
|
|
10492
|
+
/** @description Subscription the discount was granted by. */
|
|
10493
|
+
subscriptionId?: string;
|
|
10494
|
+
}[];
|
|
10495
|
+
/** @description Chargeback dispute raised against the payment, if any. */
|
|
10496
|
+
dispute?: {
|
|
10497
|
+
/**
|
|
10498
|
+
* Format: date-time
|
|
10499
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
10500
|
+
*/
|
|
10501
|
+
createDate?: string;
|
|
10502
|
+
};
|
|
10503
|
+
/** @description How the booking was paid for, and by whom. */
|
|
10504
|
+
method: {
|
|
10505
|
+
/** @description Set when `type` is `credits`. */
|
|
10506
|
+
credits?: {
|
|
10507
|
+
/** @description Customer whose credits were spent. */
|
|
10508
|
+
customer: {
|
|
10509
|
+
/**
|
|
10510
|
+
* Format: uuid
|
|
10511
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10512
|
+
*/
|
|
10513
|
+
id?: string;
|
|
10514
|
+
/** @description Location the payer belongs to. */
|
|
10515
|
+
location?: {
|
|
10516
|
+
/**
|
|
10517
|
+
* Format: uuid
|
|
10518
|
+
* @description Location id.
|
|
10519
|
+
*/
|
|
10520
|
+
id: string;
|
|
10521
|
+
/** @description Location display name. */
|
|
10522
|
+
title?: string;
|
|
10523
|
+
};
|
|
10524
|
+
/** @description First name. Present for `user` payers. */
|
|
10525
|
+
name?: string | null;
|
|
10526
|
+
/** @description Last name. Present for `user` payers. */
|
|
10527
|
+
surname?: string | null;
|
|
10528
|
+
/** @description Company name. Present for `company` payers. */
|
|
10529
|
+
title?: string;
|
|
10530
|
+
/**
|
|
10531
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10532
|
+
* @enum {string}
|
|
10533
|
+
*/
|
|
10534
|
+
type: "company" | "user";
|
|
10535
|
+
};
|
|
10536
|
+
};
|
|
10537
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
10538
|
+
dayPasses?: {
|
|
10539
|
+
/** @description Customer whose day passes were spent. */
|
|
10540
|
+
customer: {
|
|
10541
|
+
/**
|
|
10542
|
+
* Format: uuid
|
|
10543
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10544
|
+
*/
|
|
10545
|
+
id?: string;
|
|
10546
|
+
/** @description Location the payer belongs to. */
|
|
10547
|
+
location?: {
|
|
10548
|
+
/**
|
|
10549
|
+
* Format: uuid
|
|
10550
|
+
* @description Location id.
|
|
10551
|
+
*/
|
|
10552
|
+
id: string;
|
|
10553
|
+
/** @description Location display name. */
|
|
10554
|
+
title?: string;
|
|
10555
|
+
};
|
|
10556
|
+
/** @description First name. Present for `user` payers. */
|
|
10557
|
+
name?: string | null;
|
|
10558
|
+
/** @description Last name. Present for `user` payers. */
|
|
10559
|
+
surname?: string | null;
|
|
10560
|
+
/** @description Company name. Present for `company` payers. */
|
|
10561
|
+
title?: string;
|
|
10562
|
+
/**
|
|
10563
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10564
|
+
* @enum {string}
|
|
10565
|
+
*/
|
|
10566
|
+
type: "company" | "user";
|
|
10567
|
+
};
|
|
10568
|
+
};
|
|
10569
|
+
/** @description Set when `type` is `external`. */
|
|
10570
|
+
external?: {
|
|
10571
|
+
/** @description Customer who paid outside of Spacebring. */
|
|
10572
|
+
customer: {
|
|
10573
|
+
/**
|
|
10574
|
+
* Format: uuid
|
|
10575
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10576
|
+
*/
|
|
10577
|
+
id?: string;
|
|
10578
|
+
/** @description Location the payer belongs to. */
|
|
10579
|
+
location?: {
|
|
10580
|
+
/**
|
|
10581
|
+
* Format: uuid
|
|
10582
|
+
* @description Location id.
|
|
10583
|
+
*/
|
|
10584
|
+
id: string;
|
|
10585
|
+
/** @description Location display name. */
|
|
10586
|
+
title?: string;
|
|
10587
|
+
};
|
|
10588
|
+
/** @description First name. Present for `user` payers. */
|
|
10589
|
+
name?: string | null;
|
|
10590
|
+
/** @description Last name. Present for `user` payers. */
|
|
10591
|
+
surname?: string | null;
|
|
10592
|
+
/** @description Company name. Present for `company` payers. */
|
|
10593
|
+
title?: string;
|
|
10594
|
+
/**
|
|
10595
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10596
|
+
* @enum {string}
|
|
10597
|
+
*/
|
|
10598
|
+
type: "company" | "user";
|
|
10599
|
+
};
|
|
10600
|
+
};
|
|
10601
|
+
/** @description Set when `type` is `invoice`. */
|
|
10602
|
+
invoice?: {
|
|
10603
|
+
/** @description Customer the booking was invoiced to. */
|
|
10604
|
+
customer: {
|
|
10605
|
+
/**
|
|
10606
|
+
* Format: uuid
|
|
10607
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10608
|
+
*/
|
|
10609
|
+
id?: string;
|
|
10610
|
+
/** @description Location the payer belongs to. */
|
|
10611
|
+
location?: {
|
|
10612
|
+
/**
|
|
10613
|
+
* Format: uuid
|
|
10614
|
+
* @description Location id.
|
|
10615
|
+
*/
|
|
10616
|
+
id: string;
|
|
10617
|
+
/** @description Location display name. */
|
|
10618
|
+
title?: string;
|
|
10619
|
+
};
|
|
10620
|
+
/** @description First name. Present for `user` payers. */
|
|
10621
|
+
name?: string | null;
|
|
10622
|
+
/** @description Last name. Present for `user` payers. */
|
|
10623
|
+
surname?: string | null;
|
|
10624
|
+
/** @description Company name. Present for `company` payers. */
|
|
10625
|
+
title?: string;
|
|
10626
|
+
/**
|
|
10627
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10628
|
+
* @enum {string}
|
|
10629
|
+
*/
|
|
10630
|
+
type: "company" | "user";
|
|
10631
|
+
};
|
|
10632
|
+
/** @description ID of the invoice item the booking was billed on. */
|
|
10633
|
+
invoiceItemRef?: string;
|
|
10634
|
+
/**
|
|
10635
|
+
* Format: uuid
|
|
10636
|
+
* @description Subscription the invoice item belongs to.
|
|
10637
|
+
*/
|
|
10638
|
+
subscriptionRef?: string;
|
|
10639
|
+
};
|
|
10640
|
+
/** @description Set when `type` is `paymentGateway`. */
|
|
10641
|
+
paymentGateway?: {
|
|
10642
|
+
/** @description Customer who was charged. */
|
|
10643
|
+
customer: {
|
|
10644
|
+
/**
|
|
10645
|
+
* Format: uuid
|
|
10646
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
10647
|
+
*/
|
|
10648
|
+
id?: string;
|
|
10649
|
+
/** @description Location the payer belongs to. */
|
|
10650
|
+
location?: {
|
|
10651
|
+
/**
|
|
10652
|
+
* Format: uuid
|
|
10653
|
+
* @description Location id.
|
|
10654
|
+
*/
|
|
10655
|
+
id: string;
|
|
10656
|
+
/** @description Location display name. */
|
|
10657
|
+
title?: string;
|
|
10658
|
+
};
|
|
10659
|
+
/** @description First name. Present for `user` payers. */
|
|
10660
|
+
name?: string | null;
|
|
10661
|
+
/** @description Last name. Present for `user` payers. */
|
|
10662
|
+
surname?: string | null;
|
|
10663
|
+
/** @description Company name. Present for `company` payers. */
|
|
10664
|
+
title?: string;
|
|
10665
|
+
/**
|
|
10666
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
10667
|
+
* @enum {string}
|
|
10668
|
+
*/
|
|
10669
|
+
type: "company" | "user";
|
|
10670
|
+
};
|
|
10671
|
+
/**
|
|
10672
|
+
* @description Payment gateway that processed the charge.
|
|
10673
|
+
* @enum {string}
|
|
10674
|
+
*/
|
|
10675
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
10676
|
+
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
10677
|
+
label?: string;
|
|
10678
|
+
/** @description Masked payment method identifier. */
|
|
10679
|
+
mask?: string;
|
|
10680
|
+
/** @description Display name of the payment gateway, e.g. `Stripe`. */
|
|
10681
|
+
title?: string;
|
|
10682
|
+
};
|
|
10683
|
+
/**
|
|
10684
|
+
* @description How the booking was paid for. The matching property below carries the details.
|
|
10685
|
+
* @enum {string}
|
|
10686
|
+
*/
|
|
10687
|
+
type: "credits" | "dayPasses" | "external" | "invoice" | "paymentGateway";
|
|
10688
|
+
};
|
|
10689
|
+
/** @description What the booking was charged. */
|
|
10690
|
+
price?: {
|
|
10691
|
+
/** @description Set when `type` is `credits`. */
|
|
10692
|
+
credits?: {
|
|
10693
|
+
/** @description Expiring credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
10694
|
+
expiringAmount?: number;
|
|
10695
|
+
/** @description Permanent credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
10696
|
+
permanentAmount?: number;
|
|
10697
|
+
/** @description Total credits charged. */
|
|
10698
|
+
totalAmount: number;
|
|
10699
|
+
};
|
|
10700
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
10701
|
+
dayPasses?: {
|
|
10702
|
+
/** @description Expiring day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
10703
|
+
expiringAmount?: number;
|
|
10704
|
+
/** @description Permanent day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
10705
|
+
permanentAmount?: number;
|
|
10706
|
+
/** @description Total day passes charged. */
|
|
10707
|
+
totalAmount: number;
|
|
10708
|
+
};
|
|
10709
|
+
/** @description Set when `type` is `money`. */
|
|
10710
|
+
money?: {
|
|
10711
|
+
/** @description ISO 4217 currency code. */
|
|
10712
|
+
currencyCode?: string;
|
|
10713
|
+
/** @description Total amount charged, tax included. */
|
|
10714
|
+
grossAmount: number;
|
|
10715
|
+
/** @description Whether the resource price already contained the tax, rather than the tax being added on top of it. Together with `taxRate` it is what splits `grossAmount` into its net and tax parts. Omitted when the location charges no tax. */
|
|
10716
|
+
taxIsInclusive?: boolean;
|
|
10717
|
+
/** @description Tax rate applied, in percent. Omitted when the location charges no tax. */
|
|
10718
|
+
taxRate?: number;
|
|
10719
|
+
};
|
|
10720
|
+
/**
|
|
10721
|
+
* @description What the booking was charged in.
|
|
10722
|
+
* @enum {string}
|
|
10723
|
+
*/
|
|
10724
|
+
type: "credits" | "dayPasses" | "money";
|
|
10725
|
+
};
|
|
10726
|
+
/** @description Whether the payment can still be refunded. Omitted for `invoice` payments, where refundability depends on the invoice. */
|
|
10727
|
+
refundable?: boolean;
|
|
10728
|
+
/** @description Refunds made against the payment. Omitted when nothing was refunded. */
|
|
10729
|
+
refunds?: {
|
|
10730
|
+
/** @description Set when `type` is `credits`. */
|
|
10731
|
+
credits?: {
|
|
10732
|
+
/**
|
|
10733
|
+
* @deprecated
|
|
10734
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
10735
|
+
*/
|
|
10736
|
+
amountExpiring: number;
|
|
10737
|
+
/**
|
|
10738
|
+
* @deprecated
|
|
10739
|
+
* @description Deprecated. Use `amounts` instead.
|
|
10740
|
+
*/
|
|
10741
|
+
amountPermanent: number;
|
|
10742
|
+
/** @description Total amount returned by this refund. */
|
|
10743
|
+
amountTotal: number;
|
|
10744
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
10745
|
+
amounts?: {
|
|
10746
|
+
/** @description Amount returned to this balance bucket. */
|
|
10747
|
+
amount: number;
|
|
10748
|
+
/**
|
|
10749
|
+
* Format: date-time
|
|
10750
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
10751
|
+
*/
|
|
10752
|
+
expirationDate?: string;
|
|
10753
|
+
/**
|
|
10754
|
+
* Format: uuid
|
|
10755
|
+
* @description Subscription the expiring balance belongs to.
|
|
10756
|
+
*/
|
|
10757
|
+
subscriptionRef?: string;
|
|
10758
|
+
/**
|
|
10759
|
+
* @description Balance bucket type.
|
|
10760
|
+
* @enum {string}
|
|
10761
|
+
*/
|
|
10762
|
+
type: "expiring" | "permanent";
|
|
10763
|
+
}[];
|
|
10764
|
+
/**
|
|
10765
|
+
* Format: date-time
|
|
10766
|
+
* @description ISO timestamp of when the refund was made.
|
|
10767
|
+
*/
|
|
10768
|
+
createDate?: string;
|
|
10769
|
+
/** @description Refund transaction id. */
|
|
10770
|
+
id?: string;
|
|
10771
|
+
}[];
|
|
10772
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
10773
|
+
dayPasses?: {
|
|
10774
|
+
/**
|
|
10775
|
+
* @deprecated
|
|
10776
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
10777
|
+
*/
|
|
10778
|
+
amountExpiring: number;
|
|
10779
|
+
/**
|
|
10780
|
+
* @deprecated
|
|
10781
|
+
* @description Deprecated. Use `amounts` instead.
|
|
10782
|
+
*/
|
|
10783
|
+
amountPermanent: number;
|
|
10784
|
+
/** @description Total amount returned by this refund. */
|
|
10785
|
+
amountTotal: number;
|
|
10786
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
10787
|
+
amounts?: {
|
|
10788
|
+
/** @description Amount returned to this balance bucket. */
|
|
10789
|
+
amount: number;
|
|
10790
|
+
/**
|
|
10791
|
+
* Format: date-time
|
|
10792
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
10793
|
+
*/
|
|
10794
|
+
expirationDate?: string;
|
|
10795
|
+
/**
|
|
10796
|
+
* Format: uuid
|
|
10797
|
+
* @description Subscription the expiring balance belongs to.
|
|
10798
|
+
*/
|
|
10799
|
+
subscriptionRef?: string;
|
|
10800
|
+
/**
|
|
10801
|
+
* @description Balance bucket type.
|
|
10802
|
+
* @enum {string}
|
|
10803
|
+
*/
|
|
10804
|
+
type: "expiring" | "permanent";
|
|
10805
|
+
}[];
|
|
10806
|
+
/**
|
|
10807
|
+
* Format: date-time
|
|
10808
|
+
* @description ISO timestamp of when the refund was made.
|
|
10809
|
+
*/
|
|
10810
|
+
createDate?: string;
|
|
10811
|
+
/** @description Refund transaction id. */
|
|
10812
|
+
id?: string;
|
|
10813
|
+
}[];
|
|
10814
|
+
/** @description Set when `type` is `money`. */
|
|
10815
|
+
money?: {
|
|
10816
|
+
/**
|
|
10817
|
+
* Format: date-time
|
|
10818
|
+
* @description ISO timestamp of when the refund was made.
|
|
10819
|
+
*/
|
|
10820
|
+
createDate?: string;
|
|
10821
|
+
/** @description ISO 4217 currency code. */
|
|
10822
|
+
currencyCode?: string;
|
|
10823
|
+
/** @description Gross amount returned by this refund. */
|
|
10824
|
+
grossAmount: number;
|
|
10825
|
+
/** @description Refund transaction id. */
|
|
10826
|
+
id?: string;
|
|
10827
|
+
}[];
|
|
10828
|
+
/**
|
|
10829
|
+
* @description What was refunded.
|
|
10830
|
+
* @enum {string}
|
|
10831
|
+
*/
|
|
10832
|
+
type: "credits" | "dayPasses" | "money";
|
|
10833
|
+
};
|
|
10834
|
+
/** @description Set for a pending gateway payment the current user still has to complete. */
|
|
10835
|
+
request?: {
|
|
10836
|
+
/**
|
|
10837
|
+
* Format: uuid
|
|
10838
|
+
* @description Payment request id.
|
|
10839
|
+
*/
|
|
10840
|
+
id: string;
|
|
10841
|
+
/** @description Relative URL the payer opens to complete the payment. */
|
|
10842
|
+
url: string;
|
|
10843
|
+
};
|
|
10844
|
+
/**
|
|
10845
|
+
* Format: date-time
|
|
10846
|
+
* @description ISO timestamp of when a scheduled payment will be charged.
|
|
10847
|
+
*/
|
|
10848
|
+
scheduleDate?: string;
|
|
10849
|
+
/**
|
|
10850
|
+
* @description Payment status.
|
|
10851
|
+
* @enum {string}
|
|
10852
|
+
*/
|
|
10853
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10854
|
+
/** @description Surcharge added on top of the price, if any. */
|
|
10855
|
+
surcharge?: {
|
|
10856
|
+
money: {
|
|
10857
|
+
/** @description Surcharge amount. */
|
|
10858
|
+
amount?: number;
|
|
10859
|
+
/** @description ISO 4217 currency code. */
|
|
10860
|
+
currencyCode?: string;
|
|
10861
|
+
/** @description Surcharge percentage applied. */
|
|
10862
|
+
percentage?: number;
|
|
10863
|
+
/** @description Surcharge rate. */
|
|
10864
|
+
rate?: number;
|
|
10865
|
+
};
|
|
10866
|
+
/**
|
|
10867
|
+
* @description Surcharge type.
|
|
10868
|
+
* @enum {string}
|
|
10869
|
+
*/
|
|
10870
|
+
type: "money";
|
|
10871
|
+
};
|
|
10872
|
+
/** @description ID of the transaction the payment was recorded as. */
|
|
10873
|
+
transactionRef?: string;
|
|
10874
|
+
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
10875
|
+
type?: string;
|
|
10876
|
+
}[];
|
|
10877
|
+
/**
|
|
10878
|
+
* Format: uuid
|
|
10879
|
+
* @description ID of the booked resource.
|
|
10880
|
+
*/
|
|
10881
|
+
resourceRef: string;
|
|
10882
|
+
/** @description Number of seats reserved. */
|
|
10883
|
+
seats?: number;
|
|
10884
|
+
/**
|
|
10885
|
+
* Format: date-time
|
|
10886
|
+
* @description ISO timestamp when the booking starts.
|
|
10887
|
+
*/
|
|
10888
|
+
startDate: string;
|
|
10889
|
+
/** @description Custom booking title. Omitted when the owner has restricted title visibility. */
|
|
10890
|
+
title?: string;
|
|
10891
|
+
/**
|
|
10892
|
+
* Format: date-time
|
|
10893
|
+
* @description ISO timestamp when the booking was last updated.
|
|
10894
|
+
*/
|
|
10895
|
+
updateDate?: string;
|
|
10896
|
+
/** @description Profile of the booking owner. Omitted when the owner has restricted visibility. */
|
|
10897
|
+
userOwner?: {
|
|
10898
|
+
/** @description Short bio of the user. */
|
|
10899
|
+
about?: string | null;
|
|
10900
|
+
/** @description Company the user belongs to, if any. */
|
|
10901
|
+
company?: {
|
|
10902
|
+
/** @description Company display name. */
|
|
10903
|
+
title: string;
|
|
10904
|
+
} | null;
|
|
10905
|
+
/**
|
|
10906
|
+
* Format: email
|
|
10907
|
+
* @description Email address of the user.
|
|
10908
|
+
*/
|
|
10909
|
+
email?: string | null;
|
|
10910
|
+
/**
|
|
10911
|
+
* Format: uuid
|
|
10912
|
+
* @description Unique identifier of the user.
|
|
10913
|
+
*/
|
|
10914
|
+
id: string;
|
|
10915
|
+
/** @description First name of the user. */
|
|
10916
|
+
name?: string | null;
|
|
10917
|
+
/** @description Phone number of the user. */
|
|
10918
|
+
phoneNumber?: string | null;
|
|
10919
|
+
/** @description Profile photo URL of the user. */
|
|
10920
|
+
photoUrl?: string | null;
|
|
10921
|
+
/** @description Last name of the user. */
|
|
10922
|
+
surname?: string | null;
|
|
10923
|
+
};
|
|
10924
|
+
}[];
|
|
10925
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
10926
|
+
nextPageToken?: string;
|
|
10927
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
10928
|
+
searchQueryNext?: string;
|
|
10929
|
+
};
|
|
10930
|
+
getBooking: {
|
|
10931
|
+
/** @description The booking. */
|
|
10932
|
+
booking: {
|
|
10933
|
+
/** @description Attendees of the booking. Empty when the caller has no access to booking details. */
|
|
10934
|
+
attendees: {
|
|
10935
|
+
/**
|
|
10936
|
+
* Format: uuid
|
|
10937
|
+
* @description Membership id of the attendee.
|
|
10938
|
+
*/
|
|
10939
|
+
membershipRef?: string;
|
|
10940
|
+
/** @description User profile of the attendee. */
|
|
10941
|
+
user?: {
|
|
10942
|
+
/** @description Short bio of the user. */
|
|
10943
|
+
about?: string | null;
|
|
10944
|
+
/** @description Company the user belongs to, if any. */
|
|
10945
|
+
company?: {
|
|
10946
|
+
/** @description Company display name. */
|
|
10947
|
+
title: string;
|
|
10948
|
+
} | null;
|
|
10949
|
+
/**
|
|
10950
|
+
* Format: email
|
|
10951
|
+
* @description Email address of the user.
|
|
10952
|
+
*/
|
|
10953
|
+
email?: string | null;
|
|
10954
|
+
/**
|
|
10955
|
+
* Format: uuid
|
|
10956
|
+
* @description Unique identifier of the user.
|
|
10957
|
+
*/
|
|
10958
|
+
id: string;
|
|
10959
|
+
/** @description First name of the user. */
|
|
10960
|
+
name?: string | null;
|
|
10961
|
+
/** @description Phone number of the user. */
|
|
10962
|
+
phoneNumber?: string | null;
|
|
10963
|
+
/** @description Profile photo URL of the user. */
|
|
10964
|
+
photoUrl?: string | null;
|
|
10965
|
+
/** @description Last name of the user. */
|
|
10966
|
+
surname?: string | null;
|
|
10967
|
+
};
|
|
10968
|
+
}[];
|
|
10969
|
+
/**
|
|
10970
|
+
* Format: date-time
|
|
10971
|
+
* @description ISO timestamp when the booking was created.
|
|
10972
|
+
*/
|
|
10973
|
+
createDate: string;
|
|
10974
|
+
/**
|
|
10975
|
+
* Format: date-time
|
|
10976
|
+
* @description ISO timestamp when the booking was cancelled.
|
|
10977
|
+
*/
|
|
10978
|
+
deleteDate?: string;
|
|
10979
|
+
/**
|
|
10980
|
+
* Format: date-time
|
|
10981
|
+
* @description ISO timestamp when the booking ends.
|
|
10982
|
+
*/
|
|
10983
|
+
endDate: string;
|
|
10984
|
+
/** @description Whether the booking reserves the entire resource rather than individual seats. */
|
|
10985
|
+
entire?: boolean;
|
|
10986
|
+
/** @description Unique identifier of the booking. For recurring occurrences, formatted as `{bookingId}_{isoDate}`. */
|
|
10987
|
+
id: string;
|
|
10988
|
+
/**
|
|
10989
|
+
* Format: uuid
|
|
10990
|
+
* @deprecated
|
|
10991
|
+
* @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
|
|
10992
|
+
*/
|
|
10993
|
+
membershipRefOwner?: string;
|
|
10994
|
+
/** @description Internal note. Visible to admins only. */
|
|
10995
|
+
memo?: string;
|
|
10996
|
+
/**
|
|
10997
|
+
* @deprecated
|
|
10998
|
+
* @description Deprecated. Use `payments` instead.
|
|
10999
|
+
*/
|
|
11000
|
+
payment?: {
|
|
11001
|
+
/**
|
|
11002
|
+
* Format: date-time
|
|
11003
|
+
* @description ISO timestamp of when the payment was made.
|
|
11004
|
+
*/
|
|
11005
|
+
createDate?: string;
|
|
11006
|
+
/** @description Discounts applied to the price. Omitted when none applied. */
|
|
11007
|
+
discounts?: {
|
|
11008
|
+
/** @description Applied coupon. */
|
|
11009
|
+
coupon: {
|
|
11010
|
+
/** @description Fixed discount amount, in the coupon's currency. */
|
|
11011
|
+
amountOff?: number;
|
|
11012
|
+
/** @description Currency code for amountOff. */
|
|
11013
|
+
currencyCode?: string;
|
|
11014
|
+
/** @description Coupon id. */
|
|
11015
|
+
id?: string;
|
|
11016
|
+
/** @description Percentage discount amount. */
|
|
11017
|
+
percentOff?: number;
|
|
11018
|
+
/** @description Product types this coupon applies to. */
|
|
11019
|
+
productTypes?: string[];
|
|
11020
|
+
/** @description Coupon type. */
|
|
11021
|
+
type?: string;
|
|
11022
|
+
};
|
|
11023
|
+
/** @description Applied promocode. */
|
|
11024
|
+
promocode?: {
|
|
11025
|
+
/** @description Promocode string, the way a purchase references the promocode back. */
|
|
11026
|
+
code: string;
|
|
11027
|
+
/** @description Promocode expiration. */
|
|
11028
|
+
expiration?: {
|
|
11029
|
+
/** @description ISO timestamp of when the promocode expires. */
|
|
11030
|
+
date?: string;
|
|
11031
|
+
/** @description Whether the promocode expires. */
|
|
11032
|
+
enabled: boolean;
|
|
11033
|
+
};
|
|
11034
|
+
/** @description Promocode id. */
|
|
11035
|
+
id: string;
|
|
11036
|
+
/** @description Whether the promocode is limited to a first purchase. */
|
|
11037
|
+
limitByFirstPurchase?: boolean;
|
|
11038
|
+
};
|
|
11039
|
+
/** @description Subscription the discount was granted by. */
|
|
11040
|
+
subscriptionId?: string;
|
|
11041
|
+
}[];
|
|
11042
|
+
/** @description Chargeback dispute raised against the payment, if any. */
|
|
11043
|
+
dispute?: {
|
|
11044
|
+
/**
|
|
11045
|
+
* Format: date-time
|
|
11046
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
11047
|
+
*/
|
|
11048
|
+
createDate?: string;
|
|
11049
|
+
};
|
|
11050
|
+
/** @description How the booking was paid for, and by whom. */
|
|
11051
|
+
method: {
|
|
11052
|
+
/** @description Set when `type` is `credits`. */
|
|
11053
|
+
credits?: {
|
|
11054
|
+
/** @description Customer whose credits were spent. */
|
|
11055
|
+
customer: {
|
|
11056
|
+
/**
|
|
11057
|
+
* Format: uuid
|
|
11058
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11059
|
+
*/
|
|
11060
|
+
id?: string;
|
|
11061
|
+
/** @description Location the payer belongs to. */
|
|
11062
|
+
location?: {
|
|
11063
|
+
/**
|
|
11064
|
+
* Format: uuid
|
|
11065
|
+
* @description Location id.
|
|
11066
|
+
*/
|
|
11067
|
+
id: string;
|
|
11068
|
+
/** @description Location display name. */
|
|
11069
|
+
title?: string;
|
|
11070
|
+
};
|
|
11071
|
+
/** @description First name. Present for `user` payers. */
|
|
11072
|
+
name?: string | null;
|
|
11073
|
+
/** @description Last name. Present for `user` payers. */
|
|
11074
|
+
surname?: string | null;
|
|
11075
|
+
/** @description Company name. Present for `company` payers. */
|
|
11076
|
+
title?: string;
|
|
11077
|
+
/**
|
|
11078
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11079
|
+
* @enum {string}
|
|
11080
|
+
*/
|
|
11081
|
+
type: "company" | "user";
|
|
11082
|
+
};
|
|
11083
|
+
};
|
|
11084
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
11085
|
+
dayPasses?: {
|
|
11086
|
+
/** @description Customer whose day passes were spent. */
|
|
11087
|
+
customer: {
|
|
11088
|
+
/**
|
|
11089
|
+
* Format: uuid
|
|
11090
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11091
|
+
*/
|
|
11092
|
+
id?: string;
|
|
11093
|
+
/** @description Location the payer belongs to. */
|
|
11094
|
+
location?: {
|
|
11095
|
+
/**
|
|
11096
|
+
* Format: uuid
|
|
11097
|
+
* @description Location id.
|
|
11098
|
+
*/
|
|
11099
|
+
id: string;
|
|
11100
|
+
/** @description Location display name. */
|
|
11101
|
+
title?: string;
|
|
11102
|
+
};
|
|
11103
|
+
/** @description First name. Present for `user` payers. */
|
|
11104
|
+
name?: string | null;
|
|
11105
|
+
/** @description Last name. Present for `user` payers. */
|
|
11106
|
+
surname?: string | null;
|
|
11107
|
+
/** @description Company name. Present for `company` payers. */
|
|
11108
|
+
title?: string;
|
|
11109
|
+
/**
|
|
11110
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11111
|
+
* @enum {string}
|
|
11112
|
+
*/
|
|
11113
|
+
type: "company" | "user";
|
|
11114
|
+
};
|
|
11115
|
+
};
|
|
11116
|
+
/** @description Set when `type` is `external`. */
|
|
11117
|
+
external?: {
|
|
11118
|
+
/** @description Customer who paid outside of Spacebring. */
|
|
11119
|
+
customer: {
|
|
11120
|
+
/**
|
|
11121
|
+
* Format: uuid
|
|
11122
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11123
|
+
*/
|
|
11124
|
+
id?: string;
|
|
11125
|
+
/** @description Location the payer belongs to. */
|
|
11126
|
+
location?: {
|
|
11127
|
+
/**
|
|
11128
|
+
* Format: uuid
|
|
11129
|
+
* @description Location id.
|
|
11130
|
+
*/
|
|
11131
|
+
id: string;
|
|
11132
|
+
/** @description Location display name. */
|
|
11133
|
+
title?: string;
|
|
11134
|
+
};
|
|
11135
|
+
/** @description First name. Present for `user` payers. */
|
|
11136
|
+
name?: string | null;
|
|
11137
|
+
/** @description Last name. Present for `user` payers. */
|
|
11138
|
+
surname?: string | null;
|
|
11139
|
+
/** @description Company name. Present for `company` payers. */
|
|
11140
|
+
title?: string;
|
|
11141
|
+
/**
|
|
11142
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11143
|
+
* @enum {string}
|
|
11144
|
+
*/
|
|
11145
|
+
type: "company" | "user";
|
|
11146
|
+
};
|
|
11147
|
+
};
|
|
11148
|
+
/** @description Set when `type` is `invoice`. */
|
|
11149
|
+
invoice?: {
|
|
11150
|
+
/** @description Customer the booking was invoiced to. */
|
|
11151
|
+
customer: {
|
|
11152
|
+
/**
|
|
11153
|
+
* Format: uuid
|
|
11154
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11155
|
+
*/
|
|
11156
|
+
id?: string;
|
|
11157
|
+
/** @description Location the payer belongs to. */
|
|
11158
|
+
location?: {
|
|
11159
|
+
/**
|
|
11160
|
+
* Format: uuid
|
|
11161
|
+
* @description Location id.
|
|
11162
|
+
*/
|
|
11163
|
+
id: string;
|
|
11164
|
+
/** @description Location display name. */
|
|
11165
|
+
title?: string;
|
|
11166
|
+
};
|
|
11167
|
+
/** @description First name. Present for `user` payers. */
|
|
11168
|
+
name?: string | null;
|
|
11169
|
+
/** @description Last name. Present for `user` payers. */
|
|
11170
|
+
surname?: string | null;
|
|
11171
|
+
/** @description Company name. Present for `company` payers. */
|
|
11172
|
+
title?: string;
|
|
11173
|
+
/**
|
|
11174
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11175
|
+
* @enum {string}
|
|
11176
|
+
*/
|
|
11177
|
+
type: "company" | "user";
|
|
11178
|
+
};
|
|
11179
|
+
/** @description ID of the invoice item the booking was billed on. */
|
|
11180
|
+
invoiceItemRef?: string;
|
|
11181
|
+
/**
|
|
11182
|
+
* Format: uuid
|
|
11183
|
+
* @description Subscription the invoice item belongs to.
|
|
11184
|
+
*/
|
|
11185
|
+
subscriptionRef?: string;
|
|
11186
|
+
};
|
|
11187
|
+
/** @description Set when `type` is `paymentGateway`. */
|
|
11188
|
+
paymentGateway?: {
|
|
11189
|
+
/** @description Customer who was charged. */
|
|
11190
|
+
customer: {
|
|
11191
|
+
/**
|
|
11192
|
+
* Format: uuid
|
|
11193
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11194
|
+
*/
|
|
11195
|
+
id?: string;
|
|
11196
|
+
/** @description Location the payer belongs to. */
|
|
11197
|
+
location?: {
|
|
11198
|
+
/**
|
|
11199
|
+
* Format: uuid
|
|
11200
|
+
* @description Location id.
|
|
11201
|
+
*/
|
|
11202
|
+
id: string;
|
|
11203
|
+
/** @description Location display name. */
|
|
11204
|
+
title?: string;
|
|
11205
|
+
};
|
|
11206
|
+
/** @description First name. Present for `user` payers. */
|
|
11207
|
+
name?: string | null;
|
|
11208
|
+
/** @description Last name. Present for `user` payers. */
|
|
11209
|
+
surname?: string | null;
|
|
11210
|
+
/** @description Company name. Present for `company` payers. */
|
|
11211
|
+
title?: string;
|
|
11212
|
+
/**
|
|
11213
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11214
|
+
* @enum {string}
|
|
11215
|
+
*/
|
|
11216
|
+
type: "company" | "user";
|
|
11217
|
+
};
|
|
11218
|
+
/**
|
|
11219
|
+
* @description Payment gateway that processed the charge.
|
|
11220
|
+
* @enum {string}
|
|
11221
|
+
*/
|
|
11222
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
11223
|
+
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
11224
|
+
label?: string;
|
|
11225
|
+
/** @description Masked payment method identifier. */
|
|
11226
|
+
mask?: string;
|
|
11227
|
+
/** @description Display name of the payment gateway, e.g. `Stripe`. */
|
|
11228
|
+
title?: string;
|
|
11229
|
+
};
|
|
11230
|
+
/**
|
|
11231
|
+
* @description How the booking was paid for. The matching property below carries the details.
|
|
11232
|
+
* @enum {string}
|
|
11233
|
+
*/
|
|
11234
|
+
type: "credits" | "dayPasses" | "external" | "invoice" | "paymentGateway";
|
|
11235
|
+
};
|
|
11236
|
+
/** @description What the booking was charged. */
|
|
11237
|
+
price?: {
|
|
11238
|
+
/** @description Set when `type` is `credits`. */
|
|
11239
|
+
credits?: {
|
|
11240
|
+
/** @description Expiring credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
11241
|
+
expiringAmount?: number;
|
|
11242
|
+
/** @description Permanent credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
11243
|
+
permanentAmount?: number;
|
|
11244
|
+
/** @description Total credits charged. */
|
|
11245
|
+
totalAmount: number;
|
|
11246
|
+
};
|
|
11247
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
11248
|
+
dayPasses?: {
|
|
11249
|
+
/** @description Expiring day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
11250
|
+
expiringAmount?: number;
|
|
11251
|
+
/** @description Permanent day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
11252
|
+
permanentAmount?: number;
|
|
11253
|
+
/** @description Total day passes charged. */
|
|
11254
|
+
totalAmount: number;
|
|
11255
|
+
};
|
|
11256
|
+
/** @description Set when `type` is `money`. */
|
|
11257
|
+
money?: {
|
|
11258
|
+
/** @description ISO 4217 currency code. */
|
|
11259
|
+
currencyCode?: string;
|
|
11260
|
+
/** @description Total amount charged, tax included. */
|
|
11261
|
+
grossAmount: number;
|
|
11262
|
+
/** @description Whether the resource price already contained the tax, rather than the tax being added on top of it. Together with `taxRate` it is what splits `grossAmount` into its net and tax parts. Omitted when the location charges no tax. */
|
|
11263
|
+
taxIsInclusive?: boolean;
|
|
11264
|
+
/** @description Tax rate applied, in percent. Omitted when the location charges no tax. */
|
|
11265
|
+
taxRate?: number;
|
|
11266
|
+
};
|
|
11267
|
+
/**
|
|
11268
|
+
* @description What the booking was charged in.
|
|
11269
|
+
* @enum {string}
|
|
11270
|
+
*/
|
|
11271
|
+
type: "credits" | "dayPasses" | "money";
|
|
11272
|
+
};
|
|
11273
|
+
/** @description Whether the payment can still be refunded. Omitted for `invoice` payments, where refundability depends on the invoice. */
|
|
11274
|
+
refundable?: boolean;
|
|
11275
|
+
/** @description Refunds made against the payment. Omitted when nothing was refunded. */
|
|
11276
|
+
refunds?: {
|
|
11277
|
+
/** @description Set when `type` is `credits`. */
|
|
11278
|
+
credits?: {
|
|
11279
|
+
/**
|
|
11280
|
+
* @deprecated
|
|
11281
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
11282
|
+
*/
|
|
11283
|
+
amountExpiring: number;
|
|
11284
|
+
/**
|
|
11285
|
+
* @deprecated
|
|
11286
|
+
* @description Deprecated. Use `amounts` instead.
|
|
11287
|
+
*/
|
|
11288
|
+
amountPermanent: number;
|
|
11289
|
+
/** @description Total amount returned by this refund. */
|
|
11290
|
+
amountTotal: number;
|
|
11291
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
11292
|
+
amounts?: {
|
|
11293
|
+
/** @description Amount returned to this balance bucket. */
|
|
11294
|
+
amount: number;
|
|
11295
|
+
/**
|
|
11296
|
+
* Format: date-time
|
|
11297
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
11298
|
+
*/
|
|
11299
|
+
expirationDate?: string;
|
|
11300
|
+
/**
|
|
11301
|
+
* Format: uuid
|
|
11302
|
+
* @description Subscription the expiring balance belongs to.
|
|
11303
|
+
*/
|
|
11304
|
+
subscriptionRef?: string;
|
|
11305
|
+
/**
|
|
11306
|
+
* @description Balance bucket type.
|
|
11307
|
+
* @enum {string}
|
|
11308
|
+
*/
|
|
11309
|
+
type: "expiring" | "permanent";
|
|
11310
|
+
}[];
|
|
11311
|
+
/**
|
|
11312
|
+
* Format: date-time
|
|
11313
|
+
* @description ISO timestamp of when the refund was made.
|
|
11314
|
+
*/
|
|
11315
|
+
createDate?: string;
|
|
11316
|
+
/** @description Refund transaction id. */
|
|
11317
|
+
id?: string;
|
|
11318
|
+
}[];
|
|
11319
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
11320
|
+
dayPasses?: {
|
|
11321
|
+
/**
|
|
11322
|
+
* @deprecated
|
|
11323
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
11324
|
+
*/
|
|
11325
|
+
amountExpiring: number;
|
|
11326
|
+
/**
|
|
11327
|
+
* @deprecated
|
|
11328
|
+
* @description Deprecated. Use `amounts` instead.
|
|
11329
|
+
*/
|
|
11330
|
+
amountPermanent: number;
|
|
11331
|
+
/** @description Total amount returned by this refund. */
|
|
11332
|
+
amountTotal: number;
|
|
11333
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
11334
|
+
amounts?: {
|
|
11335
|
+
/** @description Amount returned to this balance bucket. */
|
|
11336
|
+
amount: number;
|
|
11337
|
+
/**
|
|
11338
|
+
* Format: date-time
|
|
11339
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
11340
|
+
*/
|
|
11341
|
+
expirationDate?: string;
|
|
11342
|
+
/**
|
|
11343
|
+
* Format: uuid
|
|
11344
|
+
* @description Subscription the expiring balance belongs to.
|
|
11345
|
+
*/
|
|
11346
|
+
subscriptionRef?: string;
|
|
11347
|
+
/**
|
|
11348
|
+
* @description Balance bucket type.
|
|
11349
|
+
* @enum {string}
|
|
11350
|
+
*/
|
|
11351
|
+
type: "expiring" | "permanent";
|
|
11352
|
+
}[];
|
|
11353
|
+
/**
|
|
11354
|
+
* Format: date-time
|
|
11355
|
+
* @description ISO timestamp of when the refund was made.
|
|
11356
|
+
*/
|
|
11357
|
+
createDate?: string;
|
|
11358
|
+
/** @description Refund transaction id. */
|
|
11359
|
+
id?: string;
|
|
11360
|
+
}[];
|
|
11361
|
+
/** @description Set when `type` is `money`. */
|
|
11362
|
+
money?: {
|
|
11363
|
+
/**
|
|
11364
|
+
* Format: date-time
|
|
11365
|
+
* @description ISO timestamp of when the refund was made.
|
|
11366
|
+
*/
|
|
11367
|
+
createDate?: string;
|
|
11368
|
+
/** @description ISO 4217 currency code. */
|
|
11369
|
+
currencyCode?: string;
|
|
11370
|
+
/** @description Gross amount returned by this refund. */
|
|
11371
|
+
grossAmount: number;
|
|
11372
|
+
/** @description Refund transaction id. */
|
|
11373
|
+
id?: string;
|
|
11374
|
+
}[];
|
|
11375
|
+
/**
|
|
11376
|
+
* @description What was refunded.
|
|
11377
|
+
* @enum {string}
|
|
11378
|
+
*/
|
|
11379
|
+
type: "credits" | "dayPasses" | "money";
|
|
11380
|
+
};
|
|
11381
|
+
/** @description Set for a pending gateway payment the current user still has to complete. */
|
|
11382
|
+
request?: {
|
|
11383
|
+
/**
|
|
11384
|
+
* Format: uuid
|
|
11385
|
+
* @description Payment request id.
|
|
11386
|
+
*/
|
|
11387
|
+
id: string;
|
|
11388
|
+
/** @description Relative URL the payer opens to complete the payment. */
|
|
11389
|
+
url: string;
|
|
11390
|
+
};
|
|
11391
|
+
/**
|
|
11392
|
+
* Format: date-time
|
|
11393
|
+
* @description ISO timestamp of when a scheduled payment will be charged.
|
|
11394
|
+
*/
|
|
11395
|
+
scheduleDate?: string;
|
|
11396
|
+
/**
|
|
11397
|
+
* @description Payment status.
|
|
11398
|
+
* @enum {string}
|
|
11399
|
+
*/
|
|
11400
|
+
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
11401
|
+
/** @description Surcharge added on top of the price, if any. */
|
|
11402
|
+
surcharge?: {
|
|
11403
|
+
money: {
|
|
11404
|
+
/** @description Surcharge amount. */
|
|
11405
|
+
amount?: number;
|
|
11406
|
+
/** @description ISO 4217 currency code. */
|
|
11407
|
+
currencyCode?: string;
|
|
11408
|
+
/** @description Surcharge percentage applied. */
|
|
11409
|
+
percentage?: number;
|
|
11410
|
+
/** @description Surcharge rate. */
|
|
11411
|
+
rate?: number;
|
|
11412
|
+
};
|
|
11413
|
+
/**
|
|
11414
|
+
* @description Surcharge type.
|
|
11415
|
+
* @enum {string}
|
|
11416
|
+
*/
|
|
11417
|
+
type: "money";
|
|
11418
|
+
};
|
|
11419
|
+
/** @description ID of the transaction the payment was recorded as. */
|
|
11420
|
+
transactionRef?: string;
|
|
11421
|
+
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
11422
|
+
type?: string;
|
|
11423
|
+
};
|
|
11424
|
+
/** @description How the booking was paid for, oldest first. One entry per settling transaction, so a credits or day passes payment that was charged and later partly refunded lists each transaction separately. Omitted when the caller has no access. */
|
|
11425
|
+
payments?: {
|
|
11426
|
+
/**
|
|
11427
|
+
* Format: date-time
|
|
11428
|
+
* @description ISO timestamp of when the payment was made.
|
|
11429
|
+
*/
|
|
11430
|
+
createDate?: string;
|
|
11431
|
+
/** @description Discounts applied to the price. Omitted when none applied. */
|
|
11432
|
+
discounts?: {
|
|
11433
|
+
/** @description Applied coupon. */
|
|
11434
|
+
coupon: {
|
|
11435
|
+
/** @description Fixed discount amount, in the coupon's currency. */
|
|
11436
|
+
amountOff?: number;
|
|
11437
|
+
/** @description Currency code for amountOff. */
|
|
11438
|
+
currencyCode?: string;
|
|
11439
|
+
/** @description Coupon id. */
|
|
11440
|
+
id?: string;
|
|
11441
|
+
/** @description Percentage discount amount. */
|
|
11442
|
+
percentOff?: number;
|
|
11443
|
+
/** @description Product types this coupon applies to. */
|
|
11444
|
+
productTypes?: string[];
|
|
11445
|
+
/** @description Coupon type. */
|
|
11446
|
+
type?: string;
|
|
11447
|
+
};
|
|
11448
|
+
/** @description Applied promocode. */
|
|
11449
|
+
promocode?: {
|
|
11450
|
+
/** @description Promocode string, the way a purchase references the promocode back. */
|
|
11451
|
+
code: string;
|
|
11452
|
+
/** @description Promocode expiration. */
|
|
11453
|
+
expiration?: {
|
|
11454
|
+
/** @description ISO timestamp of when the promocode expires. */
|
|
11455
|
+
date?: string;
|
|
11456
|
+
/** @description Whether the promocode expires. */
|
|
11457
|
+
enabled: boolean;
|
|
11458
|
+
};
|
|
11459
|
+
/** @description Promocode id. */
|
|
11460
|
+
id: string;
|
|
11461
|
+
/** @description Whether the promocode is limited to a first purchase. */
|
|
11462
|
+
limitByFirstPurchase?: boolean;
|
|
11463
|
+
};
|
|
11464
|
+
/** @description Subscription the discount was granted by. */
|
|
11465
|
+
subscriptionId?: string;
|
|
11466
|
+
}[];
|
|
11467
|
+
/** @description Chargeback dispute raised against the payment, if any. */
|
|
11468
|
+
dispute?: {
|
|
11469
|
+
/**
|
|
11470
|
+
* Format: date-time
|
|
11471
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
11472
|
+
*/
|
|
11473
|
+
createDate?: string;
|
|
11474
|
+
};
|
|
11475
|
+
/** @description How the booking was paid for, and by whom. */
|
|
11476
|
+
method: {
|
|
11477
|
+
/** @description Set when `type` is `credits`. */
|
|
11478
|
+
credits?: {
|
|
11479
|
+
/** @description Customer whose credits were spent. */
|
|
11480
|
+
customer: {
|
|
11481
|
+
/**
|
|
11482
|
+
* Format: uuid
|
|
11483
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11484
|
+
*/
|
|
11485
|
+
id?: string;
|
|
11486
|
+
/** @description Location the payer belongs to. */
|
|
11487
|
+
location?: {
|
|
11488
|
+
/**
|
|
11489
|
+
* Format: uuid
|
|
11490
|
+
* @description Location id.
|
|
11491
|
+
*/
|
|
11492
|
+
id: string;
|
|
11493
|
+
/** @description Location display name. */
|
|
11494
|
+
title?: string;
|
|
11495
|
+
};
|
|
11496
|
+
/** @description First name. Present for `user` payers. */
|
|
11497
|
+
name?: string | null;
|
|
11498
|
+
/** @description Last name. Present for `user` payers. */
|
|
11499
|
+
surname?: string | null;
|
|
11500
|
+
/** @description Company name. Present for `company` payers. */
|
|
11501
|
+
title?: string;
|
|
11502
|
+
/**
|
|
11503
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11504
|
+
* @enum {string}
|
|
11505
|
+
*/
|
|
11506
|
+
type: "company" | "user";
|
|
11507
|
+
};
|
|
11508
|
+
};
|
|
11509
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
11510
|
+
dayPasses?: {
|
|
11511
|
+
/** @description Customer whose day passes were spent. */
|
|
11512
|
+
customer: {
|
|
11513
|
+
/**
|
|
11514
|
+
* Format: uuid
|
|
11515
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11516
|
+
*/
|
|
11517
|
+
id?: string;
|
|
11518
|
+
/** @description Location the payer belongs to. */
|
|
11519
|
+
location?: {
|
|
11520
|
+
/**
|
|
11521
|
+
* Format: uuid
|
|
11522
|
+
* @description Location id.
|
|
11523
|
+
*/
|
|
11524
|
+
id: string;
|
|
11525
|
+
/** @description Location display name. */
|
|
11526
|
+
title?: string;
|
|
11527
|
+
};
|
|
11528
|
+
/** @description First name. Present for `user` payers. */
|
|
11529
|
+
name?: string | null;
|
|
11530
|
+
/** @description Last name. Present for `user` payers. */
|
|
11531
|
+
surname?: string | null;
|
|
11532
|
+
/** @description Company name. Present for `company` payers. */
|
|
11533
|
+
title?: string;
|
|
11534
|
+
/**
|
|
11535
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11536
|
+
* @enum {string}
|
|
11537
|
+
*/
|
|
11538
|
+
type: "company" | "user";
|
|
11539
|
+
};
|
|
11540
|
+
};
|
|
11541
|
+
/** @description Set when `type` is `external`. */
|
|
11542
|
+
external?: {
|
|
11543
|
+
/** @description Customer who paid outside of Spacebring. */
|
|
11544
|
+
customer: {
|
|
11545
|
+
/**
|
|
11546
|
+
* Format: uuid
|
|
11547
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11548
|
+
*/
|
|
11549
|
+
id?: string;
|
|
11550
|
+
/** @description Location the payer belongs to. */
|
|
11551
|
+
location?: {
|
|
11552
|
+
/**
|
|
11553
|
+
* Format: uuid
|
|
11554
|
+
* @description Location id.
|
|
11555
|
+
*/
|
|
11556
|
+
id: string;
|
|
11557
|
+
/** @description Location display name. */
|
|
11558
|
+
title?: string;
|
|
11559
|
+
};
|
|
11560
|
+
/** @description First name. Present for `user` payers. */
|
|
11561
|
+
name?: string | null;
|
|
11562
|
+
/** @description Last name. Present for `user` payers. */
|
|
11563
|
+
surname?: string | null;
|
|
11564
|
+
/** @description Company name. Present for `company` payers. */
|
|
11565
|
+
title?: string;
|
|
11566
|
+
/**
|
|
11567
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11568
|
+
* @enum {string}
|
|
11569
|
+
*/
|
|
11570
|
+
type: "company" | "user";
|
|
11571
|
+
};
|
|
11572
|
+
};
|
|
11573
|
+
/** @description Set when `type` is `invoice`. */
|
|
11574
|
+
invoice?: {
|
|
11575
|
+
/** @description Customer the booking was invoiced to. */
|
|
11576
|
+
customer: {
|
|
11577
|
+
/**
|
|
11578
|
+
* Format: uuid
|
|
11579
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11580
|
+
*/
|
|
11581
|
+
id?: string;
|
|
11582
|
+
/** @description Location the payer belongs to. */
|
|
11583
|
+
location?: {
|
|
11584
|
+
/**
|
|
11585
|
+
* Format: uuid
|
|
11586
|
+
* @description Location id.
|
|
11587
|
+
*/
|
|
11588
|
+
id: string;
|
|
11589
|
+
/** @description Location display name. */
|
|
11590
|
+
title?: string;
|
|
11591
|
+
};
|
|
11592
|
+
/** @description First name. Present for `user` payers. */
|
|
11593
|
+
name?: string | null;
|
|
11594
|
+
/** @description Last name. Present for `user` payers. */
|
|
11595
|
+
surname?: string | null;
|
|
11596
|
+
/** @description Company name. Present for `company` payers. */
|
|
11597
|
+
title?: string;
|
|
11598
|
+
/**
|
|
11599
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11600
|
+
* @enum {string}
|
|
11601
|
+
*/
|
|
11602
|
+
type: "company" | "user";
|
|
11603
|
+
};
|
|
11604
|
+
/** @description ID of the invoice item the booking was billed on. */
|
|
11605
|
+
invoiceItemRef?: string;
|
|
11606
|
+
/**
|
|
11607
|
+
* Format: uuid
|
|
11608
|
+
* @description Subscription the invoice item belongs to.
|
|
11609
|
+
*/
|
|
11610
|
+
subscriptionRef?: string;
|
|
11611
|
+
};
|
|
11612
|
+
/** @description Set when `type` is `paymentGateway`. */
|
|
11613
|
+
paymentGateway?: {
|
|
11614
|
+
/** @description Customer who was charged. */
|
|
11615
|
+
customer: {
|
|
11616
|
+
/**
|
|
11617
|
+
* Format: uuid
|
|
11618
|
+
* @description Customer id. Absent when the payer record is no longer available.
|
|
11619
|
+
*/
|
|
11620
|
+
id?: string;
|
|
11621
|
+
/** @description Location the payer belongs to. */
|
|
11622
|
+
location?: {
|
|
11623
|
+
/**
|
|
11624
|
+
* Format: uuid
|
|
11625
|
+
* @description Location id.
|
|
11626
|
+
*/
|
|
11627
|
+
id: string;
|
|
11628
|
+
/** @description Location display name. */
|
|
11629
|
+
title?: string;
|
|
11630
|
+
};
|
|
11631
|
+
/** @description First name. Present for `user` payers. */
|
|
11632
|
+
name?: string | null;
|
|
11633
|
+
/** @description Last name. Present for `user` payers. */
|
|
11634
|
+
surname?: string | null;
|
|
11635
|
+
/** @description Company name. Present for `company` payers. */
|
|
11636
|
+
title?: string;
|
|
11637
|
+
/**
|
|
11638
|
+
* @description Whether the booking was paid by a company or by a user. Defaults to `user` for a personal card payment, which records no payer of its own.
|
|
11639
|
+
* @enum {string}
|
|
11640
|
+
*/
|
|
11641
|
+
type: "company" | "user";
|
|
11642
|
+
};
|
|
11643
|
+
/**
|
|
11644
|
+
* @description Payment gateway that processed the charge.
|
|
11645
|
+
* @enum {string}
|
|
11646
|
+
*/
|
|
11647
|
+
gateway?: "authorizenet" | "flow" | "fondy" | "freedompay" | "kakaopay" | "maya" | "mercadopago" | "mollie" | "paypal" | "paystack" | "payway" | "plata" | "stripe" | "tap" | "wayforpay" | "xendit";
|
|
11648
|
+
/** @description Saved payment method label, e.g. `Visa •••• 4242`. */
|
|
11649
|
+
label?: string;
|
|
11650
|
+
/** @description Masked payment method identifier. */
|
|
11651
|
+
mask?: string;
|
|
11652
|
+
/** @description Display name of the payment gateway, e.g. `Stripe`. */
|
|
11653
|
+
title?: string;
|
|
11654
|
+
};
|
|
11655
|
+
/**
|
|
11656
|
+
* @description How the booking was paid for. The matching property below carries the details.
|
|
11657
|
+
* @enum {string}
|
|
11658
|
+
*/
|
|
11659
|
+
type: "credits" | "dayPasses" | "external" | "invoice" | "paymentGateway";
|
|
11660
|
+
};
|
|
11661
|
+
/** @description What the booking was charged. */
|
|
11662
|
+
price?: {
|
|
11663
|
+
/** @description Set when `type` is `credits`. */
|
|
11664
|
+
credits?: {
|
|
11665
|
+
/** @description Expiring credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
11666
|
+
expiringAmount?: number;
|
|
11667
|
+
/** @description Permanent credits charged. Omitted on a per-transaction entry, which records no split. */
|
|
11668
|
+
permanentAmount?: number;
|
|
11669
|
+
/** @description Total credits charged. */
|
|
11670
|
+
totalAmount: number;
|
|
11671
|
+
};
|
|
11672
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
11673
|
+
dayPasses?: {
|
|
11674
|
+
/** @description Expiring day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
11675
|
+
expiringAmount?: number;
|
|
11676
|
+
/** @description Permanent day passes charged. Omitted on a per-transaction entry, which records no split. */
|
|
11677
|
+
permanentAmount?: number;
|
|
11678
|
+
/** @description Total day passes charged. */
|
|
11679
|
+
totalAmount: number;
|
|
11680
|
+
};
|
|
11681
|
+
/** @description Set when `type` is `money`. */
|
|
11682
|
+
money?: {
|
|
11683
|
+
/** @description ISO 4217 currency code. */
|
|
11684
|
+
currencyCode?: string;
|
|
11685
|
+
/** @description Total amount charged, tax included. */
|
|
11686
|
+
grossAmount: number;
|
|
11687
|
+
/** @description Whether the resource price already contained the tax, rather than the tax being added on top of it. Together with `taxRate` it is what splits `grossAmount` into its net and tax parts. Omitted when the location charges no tax. */
|
|
11688
|
+
taxIsInclusive?: boolean;
|
|
11689
|
+
/** @description Tax rate applied, in percent. Omitted when the location charges no tax. */
|
|
11690
|
+
taxRate?: number;
|
|
11691
|
+
};
|
|
11692
|
+
/**
|
|
11693
|
+
* @description What the booking was charged in.
|
|
11694
|
+
* @enum {string}
|
|
11695
|
+
*/
|
|
11696
|
+
type: "credits" | "dayPasses" | "money";
|
|
11697
|
+
};
|
|
11698
|
+
/** @description Whether the payment can still be refunded. Omitted for `invoice` payments, where refundability depends on the invoice. */
|
|
11699
|
+
refundable?: boolean;
|
|
11700
|
+
/** @description Refunds made against the payment. Omitted when nothing was refunded. */
|
|
11701
|
+
refunds?: {
|
|
11702
|
+
/** @description Set when `type` is `credits`. */
|
|
11703
|
+
credits?: {
|
|
11704
|
+
/**
|
|
11705
|
+
* @deprecated
|
|
11706
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
11707
|
+
*/
|
|
11708
|
+
amountExpiring: number;
|
|
11709
|
+
/**
|
|
11710
|
+
* @deprecated
|
|
11711
|
+
* @description Deprecated. Use `amounts` instead.
|
|
11712
|
+
*/
|
|
11713
|
+
amountPermanent: number;
|
|
11714
|
+
/** @description Total amount returned by this refund. */
|
|
11715
|
+
amountTotal: number;
|
|
11716
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
11717
|
+
amounts?: {
|
|
11718
|
+
/** @description Amount returned to this balance bucket. */
|
|
11719
|
+
amount: number;
|
|
11720
|
+
/**
|
|
11721
|
+
* Format: date-time
|
|
11722
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
11723
|
+
*/
|
|
11724
|
+
expirationDate?: string;
|
|
11725
|
+
/**
|
|
11726
|
+
* Format: uuid
|
|
11727
|
+
* @description Subscription the expiring balance belongs to.
|
|
11728
|
+
*/
|
|
11729
|
+
subscriptionRef?: string;
|
|
11730
|
+
/**
|
|
11731
|
+
* @description Balance bucket type.
|
|
11732
|
+
* @enum {string}
|
|
11733
|
+
*/
|
|
11734
|
+
type: "expiring" | "permanent";
|
|
11735
|
+
}[];
|
|
11736
|
+
/**
|
|
11737
|
+
* Format: date-time
|
|
11738
|
+
* @description ISO timestamp of when the refund was made.
|
|
11739
|
+
*/
|
|
11740
|
+
createDate?: string;
|
|
11741
|
+
/** @description Refund transaction id. */
|
|
11742
|
+
id?: string;
|
|
11743
|
+
}[];
|
|
11744
|
+
/** @description Set when `type` is `dayPasses`. */
|
|
11745
|
+
dayPasses?: {
|
|
11746
|
+
/**
|
|
11747
|
+
* @deprecated
|
|
11748
|
+
* @description Deprecated. Use `amounts` instead, which reports the expiring balances the refund returned to individually.
|
|
11749
|
+
*/
|
|
11750
|
+
amountExpiring: number;
|
|
11751
|
+
/**
|
|
11752
|
+
* @deprecated
|
|
11753
|
+
* @description Deprecated. Use `amounts` instead.
|
|
11754
|
+
*/
|
|
11755
|
+
amountPermanent: number;
|
|
11756
|
+
/** @description Total amount returned by this refund. */
|
|
11757
|
+
amountTotal: number;
|
|
11758
|
+
/** @description Balance buckets the refund returned to, one entry each. Absent on a refund made before the buckets were recorded, where only the amounts above are known. */
|
|
11759
|
+
amounts?: {
|
|
11760
|
+
/** @description Amount returned to this balance bucket. */
|
|
11761
|
+
amount: number;
|
|
11762
|
+
/**
|
|
11763
|
+
* Format: date-time
|
|
11764
|
+
* @description Expiration date of the expiring balance the amount was returned to.
|
|
11765
|
+
*/
|
|
11766
|
+
expirationDate?: string;
|
|
11767
|
+
/**
|
|
11768
|
+
* Format: uuid
|
|
11769
|
+
* @description Subscription the expiring balance belongs to.
|
|
11770
|
+
*/
|
|
11771
|
+
subscriptionRef?: string;
|
|
11772
|
+
/**
|
|
11773
|
+
* @description Balance bucket type.
|
|
11774
|
+
* @enum {string}
|
|
11775
|
+
*/
|
|
11776
|
+
type: "expiring" | "permanent";
|
|
11777
|
+
}[];
|
|
11778
|
+
/**
|
|
11779
|
+
* Format: date-time
|
|
11780
|
+
* @description ISO timestamp of when the refund was made.
|
|
11781
|
+
*/
|
|
11782
|
+
createDate?: string;
|
|
11783
|
+
/** @description Refund transaction id. */
|
|
11784
|
+
id?: string;
|
|
11785
|
+
}[];
|
|
11786
|
+
/** @description Set when `type` is `money`. */
|
|
11787
|
+
money?: {
|
|
11788
|
+
/**
|
|
11789
|
+
* Format: date-time
|
|
11790
|
+
* @description ISO timestamp of when the refund was made.
|
|
11791
|
+
*/
|
|
11792
|
+
createDate?: string;
|
|
10008
11793
|
/** @description ISO 4217 currency code. */
|
|
10009
11794
|
currencyCode?: string;
|
|
10010
|
-
/** @description
|
|
10011
|
-
|
|
10012
|
-
/** @description
|
|
10013
|
-
|
|
10014
|
-
};
|
|
11795
|
+
/** @description Gross amount returned by this refund. */
|
|
11796
|
+
grossAmount: number;
|
|
11797
|
+
/** @description Refund transaction id. */
|
|
11798
|
+
id?: string;
|
|
11799
|
+
}[];
|
|
10015
11800
|
/**
|
|
10016
|
-
* @description
|
|
11801
|
+
* @description What was refunded.
|
|
10017
11802
|
* @enum {string}
|
|
10018
11803
|
*/
|
|
10019
|
-
type: "money";
|
|
11804
|
+
type: "credits" | "dayPasses" | "money";
|
|
10020
11805
|
};
|
|
10021
|
-
/** @description
|
|
10022
|
-
|
|
10023
|
-
/** @description Payment method type. */
|
|
10024
|
-
type?: string;
|
|
10025
|
-
}[];
|
|
10026
|
-
/**
|
|
10027
|
-
* Format: uuid
|
|
10028
|
-
* @description ID of the booked resource.
|
|
10029
|
-
*/
|
|
10030
|
-
resourceRef: string;
|
|
10031
|
-
/** @description Number of seats reserved. */
|
|
10032
|
-
seats?: number;
|
|
10033
|
-
/**
|
|
10034
|
-
* Format: date-time
|
|
10035
|
-
* @description ISO timestamp when the booking starts.
|
|
10036
|
-
*/
|
|
10037
|
-
startDate: string;
|
|
10038
|
-
/** @description Custom booking title. Omitted when the owner has restricted title visibility. */
|
|
10039
|
-
title?: string;
|
|
10040
|
-
/**
|
|
10041
|
-
* Format: date-time
|
|
10042
|
-
* @description ISO timestamp when the booking was last updated.
|
|
10043
|
-
*/
|
|
10044
|
-
updateDate?: string;
|
|
10045
|
-
/** @description Profile of the booking owner. Omitted when the owner has restricted visibility. */
|
|
10046
|
-
userOwner?: {
|
|
10047
|
-
/** @description Short bio of the user. */
|
|
10048
|
-
about?: string | null;
|
|
10049
|
-
/** @description Company the user belongs to, if any. */
|
|
10050
|
-
company?: {
|
|
10051
|
-
/** @description Company display name. */
|
|
10052
|
-
title: string;
|
|
10053
|
-
} | null;
|
|
10054
|
-
/**
|
|
10055
|
-
* Format: email
|
|
10056
|
-
* @description Email address of the user.
|
|
10057
|
-
*/
|
|
10058
|
-
email?: string | null;
|
|
10059
|
-
/**
|
|
10060
|
-
* Format: uuid
|
|
10061
|
-
* @description Unique identifier of the user.
|
|
10062
|
-
*/
|
|
10063
|
-
id: string;
|
|
10064
|
-
/** @description First name of the user. */
|
|
10065
|
-
name?: string | null;
|
|
10066
|
-
/** @description Phone number of the user. */
|
|
10067
|
-
phoneNumber?: string | null;
|
|
10068
|
-
/** @description Profile photo URL of the user. */
|
|
10069
|
-
photoUrl?: string | null;
|
|
10070
|
-
/** @description Last name of the user. */
|
|
10071
|
-
surname?: string | null;
|
|
10072
|
-
};
|
|
10073
|
-
}[];
|
|
10074
|
-
/** @description Pagination token to fetch the next page of results. */
|
|
10075
|
-
nextPageToken?: string;
|
|
10076
|
-
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
10077
|
-
searchQueryNext?: string;
|
|
10078
|
-
};
|
|
10079
|
-
getBooking: {
|
|
10080
|
-
/** @description The booking. */
|
|
10081
|
-
booking: {
|
|
10082
|
-
/** @description Attendees of the booking. Empty when the caller has no access to booking details. */
|
|
10083
|
-
attendees: {
|
|
10084
|
-
/**
|
|
10085
|
-
* Format: uuid
|
|
10086
|
-
* @description Membership id of the attendee.
|
|
10087
|
-
*/
|
|
10088
|
-
membershipRef?: string;
|
|
10089
|
-
/** @description User profile of the attendee. */
|
|
10090
|
-
user?: {
|
|
10091
|
-
/** @description Short bio of the user. */
|
|
10092
|
-
about?: string | null;
|
|
10093
|
-
/** @description Company the user belongs to, if any. */
|
|
10094
|
-
company?: {
|
|
10095
|
-
/** @description Company display name. */
|
|
10096
|
-
title: string;
|
|
10097
|
-
} | null;
|
|
10098
|
-
/**
|
|
10099
|
-
* Format: email
|
|
10100
|
-
* @description Email address of the user.
|
|
10101
|
-
*/
|
|
10102
|
-
email?: string | null;
|
|
11806
|
+
/** @description Set for a pending gateway payment the current user still has to complete. */
|
|
11807
|
+
request?: {
|
|
10103
11808
|
/**
|
|
10104
11809
|
* Format: uuid
|
|
10105
|
-
* @description
|
|
11810
|
+
* @description Payment request id.
|
|
10106
11811
|
*/
|
|
10107
11812
|
id: string;
|
|
10108
|
-
/** @description
|
|
10109
|
-
|
|
10110
|
-
/** @description Phone number of the user. */
|
|
10111
|
-
phoneNumber?: string | null;
|
|
10112
|
-
/** @description Profile photo URL of the user. */
|
|
10113
|
-
photoUrl?: string | null;
|
|
10114
|
-
/** @description Last name of the user. */
|
|
10115
|
-
surname?: string | null;
|
|
11813
|
+
/** @description Relative URL the payer opens to complete the payment. */
|
|
11814
|
+
url: string;
|
|
10116
11815
|
};
|
|
10117
|
-
}[];
|
|
10118
|
-
/**
|
|
10119
|
-
* Format: date-time
|
|
10120
|
-
* @description ISO timestamp when the booking was created.
|
|
10121
|
-
*/
|
|
10122
|
-
createDate: string;
|
|
10123
|
-
/**
|
|
10124
|
-
* Format: date-time
|
|
10125
|
-
* @description ISO timestamp when the booking was cancelled.
|
|
10126
|
-
*/
|
|
10127
|
-
deleteDate?: string;
|
|
10128
|
-
/**
|
|
10129
|
-
* Format: date-time
|
|
10130
|
-
* @description ISO timestamp when the booking ends.
|
|
10131
|
-
*/
|
|
10132
|
-
endDate: string;
|
|
10133
|
-
/** @description Whether the booking reserves the entire resource rather than individual seats. */
|
|
10134
|
-
entire?: boolean;
|
|
10135
|
-
/** @description Unique identifier of the booking. For recurring occurrences, formatted as `{bookingId}_{isoDate}`. */
|
|
10136
|
-
id: string;
|
|
10137
|
-
/**
|
|
10138
|
-
* Format: uuid
|
|
10139
|
-
* @deprecated
|
|
10140
|
-
* @description Deprecated. Customer id of the booking owner. Omitted when the caller has no access.
|
|
10141
|
-
*/
|
|
10142
|
-
membershipRefOwner?: string;
|
|
10143
|
-
/** @description Internal note. Visible to admins only. */
|
|
10144
|
-
memo?: string;
|
|
10145
|
-
/**
|
|
10146
|
-
* @deprecated
|
|
10147
|
-
* @description Deprecated. Use `payments` instead.
|
|
10148
|
-
*/
|
|
10149
|
-
payment?: {
|
|
10150
|
-
/** @description Payment amount in the location currency. */
|
|
10151
|
-
amount?: number;
|
|
10152
|
-
/** @description ISO 4217 currency code. */
|
|
10153
|
-
currencyCode?: string;
|
|
10154
|
-
/** @description ID of the associated invoice item. */
|
|
10155
|
-
invoiceItemRef?: string;
|
|
10156
11816
|
/**
|
|
10157
|
-
*
|
|
10158
|
-
* @
|
|
11817
|
+
* Format: date-time
|
|
11818
|
+
* @description ISO timestamp of when a scheduled payment will be charged.
|
|
10159
11819
|
*/
|
|
10160
|
-
|
|
10161
|
-
/** @description Surcharge applied to the payment, if any. */
|
|
10162
|
-
surcharge?: {
|
|
10163
|
-
money: {
|
|
10164
|
-
/** @description Surcharge amount. */
|
|
10165
|
-
amount?: number;
|
|
10166
|
-
/** @description ISO 4217 currency code. */
|
|
10167
|
-
currencyCode?: string;
|
|
10168
|
-
/** @description Surcharge percentage applied. */
|
|
10169
|
-
percentage?: number;
|
|
10170
|
-
/** @description Surcharge rate. */
|
|
10171
|
-
rate?: number;
|
|
10172
|
-
};
|
|
10173
|
-
/**
|
|
10174
|
-
* @description Surcharge type.
|
|
10175
|
-
* @enum {string}
|
|
10176
|
-
*/
|
|
10177
|
-
type: "money";
|
|
10178
|
-
};
|
|
10179
|
-
/** @description ID of the associated transaction. */
|
|
10180
|
-
transactionRef?: string;
|
|
10181
|
-
/** @description Payment method type. */
|
|
10182
|
-
type?: string;
|
|
10183
|
-
};
|
|
10184
|
-
/** @description Payment details. Omitted when caller has no access. */
|
|
10185
|
-
payments?: {
|
|
10186
|
-
/** @description Payment amount in the location currency. */
|
|
10187
|
-
amount?: number;
|
|
10188
|
-
/** @description ISO 4217 currency code. */
|
|
10189
|
-
currencyCode?: string;
|
|
10190
|
-
/** @description ID of the associated invoice item. */
|
|
10191
|
-
invoiceItemRef?: string;
|
|
11820
|
+
scheduleDate?: string;
|
|
10192
11821
|
/**
|
|
10193
11822
|
* @description Payment status.
|
|
10194
11823
|
* @enum {string}
|
|
10195
11824
|
*/
|
|
10196
11825
|
status?: "succeeded" | "failed" | "pending" | "processing" | "canceled";
|
|
10197
|
-
/** @description Surcharge
|
|
11826
|
+
/** @description Surcharge added on top of the price, if any. */
|
|
10198
11827
|
surcharge?: {
|
|
10199
11828
|
money: {
|
|
10200
11829
|
/** @description Surcharge amount. */
|
|
@@ -10212,9 +11841,9 @@ interface components {
|
|
|
10212
11841
|
*/
|
|
10213
11842
|
type: "money";
|
|
10214
11843
|
};
|
|
10215
|
-
/** @description ID of the
|
|
11844
|
+
/** @description ID of the transaction the payment was recorded as. */
|
|
10216
11845
|
transactionRef?: string;
|
|
10217
|
-
/** @description
|
|
11846
|
+
/** @description Shorthand for the payment method: the gateway slug for `paymentGateway` payments, otherwise `method.type`. */
|
|
10218
11847
|
type?: string;
|
|
10219
11848
|
}[];
|
|
10220
11849
|
/**
|
|
@@ -19196,6 +20825,59 @@ interface components {
|
|
|
19196
20825
|
};
|
|
19197
20826
|
};
|
|
19198
20827
|
};
|
|
20828
|
+
patchBooking: {
|
|
20829
|
+
content: {
|
|
20830
|
+
"application/json": {
|
|
20831
|
+
/** @description Booking fields to update. Fields left out keep their current value. */
|
|
20832
|
+
booking: {
|
|
20833
|
+
/** @description Full list of attendees to keep on the booking. Attendees left out are removed. Supported for room resources. */
|
|
20834
|
+
attendees?: {
|
|
20835
|
+
user: {
|
|
20836
|
+
/**
|
|
20837
|
+
* Format: uuid
|
|
20838
|
+
* @description User id of the attendee.
|
|
20839
|
+
*/
|
|
20840
|
+
id: string;
|
|
20841
|
+
};
|
|
20842
|
+
}[];
|
|
20843
|
+
/**
|
|
20844
|
+
* Format: date-time
|
|
20845
|
+
* @description ISO timestamp when the booking ends.
|
|
20846
|
+
*/
|
|
20847
|
+
endDate?: string;
|
|
20848
|
+
/** @description Set to true to book the entire resource instead of individual seats. Supported for office resources. */
|
|
20849
|
+
entire?: boolean;
|
|
20850
|
+
/** @description Internal note attached to the booking. */
|
|
20851
|
+
memo?: string;
|
|
20852
|
+
/**
|
|
20853
|
+
* Format: uuid
|
|
20854
|
+
* @description ID of the resource to move the booking to. The target must belong to the same location, be of an interchangeable type, and sell the booking's payment method at the same price. Not supported for repeating bookings.
|
|
20855
|
+
*/
|
|
20856
|
+
resourceRef?: string;
|
|
20857
|
+
/** @description Number of seats to reserve. Supported for desk and office resources. */
|
|
20858
|
+
seats?: number;
|
|
20859
|
+
/**
|
|
20860
|
+
* @description Whether to notify the owner and the attendees about the update. Defaults to the value stored on the booking.
|
|
20861
|
+
* @enum {string}
|
|
20862
|
+
*/
|
|
20863
|
+
sendUpdates?: "none" | "all";
|
|
20864
|
+
/**
|
|
20865
|
+
* Format: date-time
|
|
20866
|
+
* @description ISO timestamp when the booking starts. Patching it without an endDate moves the booking and keeps its current duration.
|
|
20867
|
+
*/
|
|
20868
|
+
startDate?: string;
|
|
20869
|
+
/** @description Custom title for the booking. */
|
|
20870
|
+
title?: string;
|
|
20871
|
+
};
|
|
20872
|
+
/**
|
|
20873
|
+
* @description For a repeating booking, whether to update only the addressed occurrence or that one and every later occurrence.
|
|
20874
|
+
* @default singleOccurrence
|
|
20875
|
+
* @enum {string}
|
|
20876
|
+
*/
|
|
20877
|
+
updateRepeatingScope?: "singleOccurrence" | "thisAndNext";
|
|
20878
|
+
};
|
|
20879
|
+
};
|
|
20880
|
+
};
|
|
19199
20881
|
createShopCategory: {
|
|
19200
20882
|
content: {
|
|
19201
20883
|
"application/json": {
|
|
@@ -25347,9 +27029,9 @@ interface operations {
|
|
|
25347
27029
|
};
|
|
25348
27030
|
getAssignments: {
|
|
25349
27031
|
parameters: {
|
|
25350
|
-
query
|
|
27032
|
+
query?: {
|
|
25351
27033
|
/** @description UUID of the location whose resource assignments to list. */
|
|
25352
|
-
locationRef
|
|
27034
|
+
locationRef?: string;
|
|
25353
27035
|
};
|
|
25354
27036
|
header?: {
|
|
25355
27037
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -25643,6 +27325,41 @@ interface operations {
|
|
|
25643
27325
|
};
|
|
25644
27326
|
};
|
|
25645
27327
|
};
|
|
27328
|
+
patchBooking: {
|
|
27329
|
+
parameters: {
|
|
27330
|
+
query?: never;
|
|
27331
|
+
header?: {
|
|
27332
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
27333
|
+
"spacebring-network-id"?: string;
|
|
27334
|
+
};
|
|
27335
|
+
path: {
|
|
27336
|
+
/** @description ID of the booking. For a single occurrence of a repeating booking, append the occurrence date: `<bookingId>_<ISO date>`. */
|
|
27337
|
+
bookingId: string;
|
|
27338
|
+
};
|
|
27339
|
+
cookie?: never;
|
|
27340
|
+
};
|
|
27341
|
+
requestBody: components["requestBodies"]["patchBooking"];
|
|
27342
|
+
responses: {
|
|
27343
|
+
/** @description OK */
|
|
27344
|
+
200: {
|
|
27345
|
+
headers: {
|
|
27346
|
+
[name: string]: unknown;
|
|
27347
|
+
};
|
|
27348
|
+
content: {
|
|
27349
|
+
"application/json": components["schemas"]["getBooking"];
|
|
27350
|
+
};
|
|
27351
|
+
};
|
|
27352
|
+
/** @description Bad Request */
|
|
27353
|
+
400: {
|
|
27354
|
+
headers: {
|
|
27355
|
+
[name: string]: unknown;
|
|
27356
|
+
};
|
|
27357
|
+
content: {
|
|
27358
|
+
"application/json": components["schemas"]["responseError"];
|
|
27359
|
+
};
|
|
27360
|
+
};
|
|
27361
|
+
};
|
|
27362
|
+
};
|
|
25646
27363
|
getShopCategories: {
|
|
25647
27364
|
parameters: {
|
|
25648
27365
|
query: {
|
|
@@ -28086,7 +29803,7 @@ type Resource = NonNullable<operations["getResource"]["responses"][200]["content
|
|
|
28086
29803
|
/** Query parameters for `sb.resources.getAssignments()`. */
|
|
28087
29804
|
interface GetAssignmentsQuery {
|
|
28088
29805
|
/** UUID of the location whose resource assignments to list. */
|
|
28089
|
-
locationRef
|
|
29806
|
+
locationRef?: string;
|
|
28090
29807
|
}
|
|
28091
29808
|
/** Query parameters for `sb.resources.bookings.list()`. */
|
|
28092
29809
|
interface GetBookingsQuery {
|
|
@@ -28150,6 +29867,8 @@ interface GetResourcesQuery {
|
|
|
28150
29867
|
type CreateBookingBody = NonNullable<NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"]["booking"]>;
|
|
28151
29868
|
/** Request body for `sb.resources.create()`. */
|
|
28152
29869
|
type CreateResourceBody = NonNullable<NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"]["resource"]>;
|
|
29870
|
+
/** Request body for `sb.resources.bookings.update()`. */
|
|
29871
|
+
type PatchBookingBody = NonNullable<operations["patchBooking"]["requestBody"]>["content"]["application/json"];
|
|
28153
29872
|
/** Request body for `sb.resources.update()`. */
|
|
28154
29873
|
type PatchResourceBody = NonNullable<NonNullable<operations["patchResource"]["requestBody"]>["content"]["application/json"]["resource"]>;
|
|
28155
29874
|
|
|
@@ -28942,7 +30661,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
28942
30661
|
get(resourceId: string, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
28943
30662
|
create(resource: CreateResourceBody, options?: SpacebringRequestOptions): Promise<Resource>;
|
|
28944
30663
|
update(resourceId: string, resource: PatchResourceBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
28945
|
-
getAssignments(query
|
|
30664
|
+
getAssignments(query?: GetAssignmentsQuery, options?: SpacebringRequestOptions): Promise<Assignment[]>;
|
|
28946
30665
|
bookings: {
|
|
28947
30666
|
list(query?: GetBookingsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
28948
30667
|
bookings: Booking[];
|
|
@@ -28952,6 +30671,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
28952
30671
|
iterate(query?: Omit<GetBookingsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Booking, void, undefined>;
|
|
28953
30672
|
get(bookingId: string, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
28954
30673
|
create(booking: CreateBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
30674
|
+
update(bookingId: string, body: PatchBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
28955
30675
|
delete(bookingId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
28956
30676
|
};
|
|
28957
30677
|
};
|
|
@@ -29179,4 +30899,4 @@ declare class SpacebringError extends Error {
|
|
|
29179
30899
|
});
|
|
29180
30900
|
}
|
|
29181
30901
|
|
|
29182
|
-
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TerminateContractBody, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };
|
|
30902
|
+
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchBookingBody, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TerminateContractBody, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };
|