@izak0s/spacebring-api 9.0.0 → 9.0.1
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 +37 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2537 -142
- package/dist/index.d.ts +2537 -142
- package/dist/index.js +37 -5
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2605,14 +2605,18 @@ interface paths {
|
|
|
2605
2605
|
*/
|
|
2606
2606
|
get: operations["getMoneyTransactions"];
|
|
2607
2607
|
put?: never;
|
|
2608
|
-
|
|
2608
|
+
/**
|
|
2609
|
+
* Create a money transaction
|
|
2610
|
+
* @description Create a money transaction by charging a customer for a custom item. <h3>OAuth</h3>Required scopes: <code>transactions</code>
|
|
2611
|
+
*/
|
|
2612
|
+
post: operations["createMoneyTransaction"];
|
|
2609
2613
|
delete?: never;
|
|
2610
2614
|
options?: never;
|
|
2611
2615
|
head?: never;
|
|
2612
2616
|
patch?: never;
|
|
2613
2617
|
trace?: never;
|
|
2614
2618
|
};
|
|
2615
|
-
"/transactions/money/v1/{
|
|
2619
|
+
"/transactions/money/v1/{transactionId}": {
|
|
2616
2620
|
parameters: {
|
|
2617
2621
|
query?: never;
|
|
2618
2622
|
header?: never;
|
|
@@ -2629,6 +2633,30 @@ interface paths {
|
|
|
2629
2633
|
delete?: never;
|
|
2630
2634
|
options?: never;
|
|
2631
2635
|
head?: never;
|
|
2636
|
+
/**
|
|
2637
|
+
* Update a money transaction
|
|
2638
|
+
* @description Approve or cancel a pending money transaction paid externally. <h3>OAuth</h3>Required scopes: <code>transactions</code>
|
|
2639
|
+
*/
|
|
2640
|
+
patch: operations["patchMoneyTransaction"];
|
|
2641
|
+
trace?: never;
|
|
2642
|
+
};
|
|
2643
|
+
"/transactions/money/v1/{transactionId}/refund": {
|
|
2644
|
+
parameters: {
|
|
2645
|
+
query?: never;
|
|
2646
|
+
header?: never;
|
|
2647
|
+
path?: never;
|
|
2648
|
+
cookie?: never;
|
|
2649
|
+
};
|
|
2650
|
+
get?: never;
|
|
2651
|
+
put?: never;
|
|
2652
|
+
/**
|
|
2653
|
+
* Refund a money transaction
|
|
2654
|
+
* @description Refund a succeeded money transaction, fully or partially, through the payment gateway it was paid with. <h3>OAuth</h3>Required scopes: <code>transactions</code>
|
|
2655
|
+
*/
|
|
2656
|
+
post: operations["refundMoneyTransaction"];
|
|
2657
|
+
delete?: never;
|
|
2658
|
+
options?: never;
|
|
2659
|
+
head?: never;
|
|
2632
2660
|
patch?: never;
|
|
2633
2661
|
trace?: never;
|
|
2634
2662
|
};
|
|
@@ -7035,9 +7063,11 @@ interface components {
|
|
|
7035
7063
|
checkInDate?: string;
|
|
7036
7064
|
/**
|
|
7037
7065
|
* Format: uuid
|
|
7038
|
-
* @description ID of the ticket's check-in in the check-ins service.
|
|
7066
|
+
* @description ID of the ticket's check-in in the check-ins service. Present when check-in is enabled for the event.
|
|
7039
7067
|
*/
|
|
7040
7068
|
checkInRef?: string;
|
|
7069
|
+
/** @description Six-digit code the attendee enters on the Reception app to check in. Visible to the ticket owner and admins when check-in is enabled for the event. */
|
|
7070
|
+
code?: string;
|
|
7041
7071
|
/**
|
|
7042
7072
|
* Format: date-time
|
|
7043
7073
|
* @description ISO timestamp of when the ticket was created.
|
|
@@ -7050,6 +7080,8 @@ interface components {
|
|
|
7050
7080
|
deleteDate?: string;
|
|
7051
7081
|
/** @description Event this ticket belongs to. */
|
|
7052
7082
|
event: {
|
|
7083
|
+
/** @description Whether attendees can be checked in, per the check-in setting of the event's location. */
|
|
7084
|
+
checkInEnabled: boolean;
|
|
7053
7085
|
/**
|
|
7054
7086
|
* Format: date-time
|
|
7055
7087
|
* @description ISO timestamp of when the event ends.
|
|
@@ -10251,6 +10283,10 @@ interface components {
|
|
|
10251
10283
|
membershipRefOwner?: string;
|
|
10252
10284
|
/** @description Note attached to the booking. Visible to the booking owner and to admins. */
|
|
10253
10285
|
memo?: string;
|
|
10286
|
+
/** @description Key-value data attached to the booking. Values cannot be objects or arrays. Available only for admins. */
|
|
10287
|
+
metadata?: {
|
|
10288
|
+
[key: string]: unknown;
|
|
10289
|
+
};
|
|
10254
10290
|
/**
|
|
10255
10291
|
* @deprecated
|
|
10256
10292
|
* @description Deprecated. Use `payments` instead.
|
|
@@ -11269,6 +11305,10 @@ interface components {
|
|
|
11269
11305
|
membershipRefOwner?: string;
|
|
11270
11306
|
/** @description Note attached to the booking. Visible to the booking owner and to admins. */
|
|
11271
11307
|
memo?: string;
|
|
11308
|
+
/** @description Key-value data attached to the booking. Values cannot be objects or arrays. Available only for admins. */
|
|
11309
|
+
metadata?: {
|
|
11310
|
+
[key: string]: unknown;
|
|
11311
|
+
};
|
|
11272
11312
|
/**
|
|
11273
11313
|
* @deprecated
|
|
11274
11314
|
* @description Deprecated. Use `payments` instead.
|
|
@@ -15794,6 +15834,8 @@ interface components {
|
|
|
15794
15834
|
key: string;
|
|
15795
15835
|
url: string;
|
|
15796
15836
|
};
|
|
15837
|
+
/** @description Public logo URL derived from the company website. */
|
|
15838
|
+
publicLogoUrl?: string;
|
|
15797
15839
|
/** @description Company name. */
|
|
15798
15840
|
title?: string;
|
|
15799
15841
|
/**
|
|
@@ -15813,6 +15855,11 @@ interface components {
|
|
|
15813
15855
|
surname?: string | null;
|
|
15814
15856
|
};
|
|
15815
15857
|
};
|
|
15858
|
+
/**
|
|
15859
|
+
* Format: uuid
|
|
15860
|
+
* @description ID of the customer the user who created the scheduled transaction belongs to.
|
|
15861
|
+
*/
|
|
15862
|
+
customerRefCreatedBy?: string;
|
|
15816
15863
|
/** @description Discounts applied to the scheduled transaction. */
|
|
15817
15864
|
discounts?: {
|
|
15818
15865
|
/** @description Applied coupon. */
|
|
@@ -15869,7 +15916,7 @@ interface components {
|
|
|
15869
15916
|
/**
|
|
15870
15917
|
* Format: uuid
|
|
15871
15918
|
* @deprecated
|
|
15872
|
-
* @description Deprecated. Use
|
|
15919
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
15873
15920
|
*/
|
|
15874
15921
|
membershipRefCreator?: string;
|
|
15875
15922
|
/**
|
|
@@ -16106,6 +16153,8 @@ interface components {
|
|
|
16106
16153
|
key: string;
|
|
16107
16154
|
url: string;
|
|
16108
16155
|
};
|
|
16156
|
+
/** @description Public logo URL derived from the company website. */
|
|
16157
|
+
publicLogoUrl?: string;
|
|
16109
16158
|
/** @description Company name. */
|
|
16110
16159
|
title?: string;
|
|
16111
16160
|
/**
|
|
@@ -16125,6 +16174,11 @@ interface components {
|
|
|
16125
16174
|
surname?: string | null;
|
|
16126
16175
|
};
|
|
16127
16176
|
};
|
|
16177
|
+
/**
|
|
16178
|
+
* Format: uuid
|
|
16179
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
16180
|
+
*/
|
|
16181
|
+
customerRefCreatedBy?: string;
|
|
16128
16182
|
/** @description Transaction description. */
|
|
16129
16183
|
description?: string;
|
|
16130
16184
|
/** @description Discounts applied to the transaction. */
|
|
@@ -16188,7 +16242,7 @@ interface components {
|
|
|
16188
16242
|
/**
|
|
16189
16243
|
* Format: uuid
|
|
16190
16244
|
* @deprecated
|
|
16191
|
-
* @description Deprecated. Use
|
|
16245
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
16192
16246
|
*/
|
|
16193
16247
|
membershipRefCreator?: string;
|
|
16194
16248
|
/**
|
|
@@ -16500,6 +16554,8 @@ interface components {
|
|
|
16500
16554
|
key: string;
|
|
16501
16555
|
url: string;
|
|
16502
16556
|
};
|
|
16557
|
+
/** @description Public logo URL derived from the company website. */
|
|
16558
|
+
publicLogoUrl?: string;
|
|
16503
16559
|
/** @description Company name. */
|
|
16504
16560
|
title?: string;
|
|
16505
16561
|
/**
|
|
@@ -16519,6 +16575,11 @@ interface components {
|
|
|
16519
16575
|
surname?: string | null;
|
|
16520
16576
|
};
|
|
16521
16577
|
};
|
|
16578
|
+
/**
|
|
16579
|
+
* Format: uuid
|
|
16580
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
16581
|
+
*/
|
|
16582
|
+
customerRefCreatedBy?: string;
|
|
16522
16583
|
/** @description Transaction description. */
|
|
16523
16584
|
description?: string;
|
|
16524
16585
|
/** @description Discounts applied to the transaction. */
|
|
@@ -16582,7 +16643,7 @@ interface components {
|
|
|
16582
16643
|
/**
|
|
16583
16644
|
* Format: uuid
|
|
16584
16645
|
* @deprecated
|
|
16585
|
-
* @description Deprecated. Use
|
|
16646
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
16586
16647
|
*/
|
|
16587
16648
|
membershipRefCreator?: string;
|
|
16588
16649
|
/**
|
|
@@ -16892,6 +16953,8 @@ interface components {
|
|
|
16892
16953
|
key: string;
|
|
16893
16954
|
url: string;
|
|
16894
16955
|
};
|
|
16956
|
+
/** @description Public logo URL derived from the company website. */
|
|
16957
|
+
publicLogoUrl?: string;
|
|
16895
16958
|
/** @description Company name. */
|
|
16896
16959
|
title?: string;
|
|
16897
16960
|
/**
|
|
@@ -16911,6 +16974,11 @@ interface components {
|
|
|
16911
16974
|
surname?: string | null;
|
|
16912
16975
|
};
|
|
16913
16976
|
};
|
|
16977
|
+
/**
|
|
16978
|
+
* Format: uuid
|
|
16979
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
16980
|
+
*/
|
|
16981
|
+
customerRefCreatedBy?: string;
|
|
16914
16982
|
/** @description Transaction description. */
|
|
16915
16983
|
description?: string;
|
|
16916
16984
|
/** @description Discounts applied to the transaction. */
|
|
@@ -16974,7 +17042,7 @@ interface components {
|
|
|
16974
17042
|
/**
|
|
16975
17043
|
* Format: uuid
|
|
16976
17044
|
* @deprecated
|
|
16977
|
-
* @description Deprecated. Use
|
|
17045
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
16978
17046
|
*/
|
|
16979
17047
|
membershipRefCreator?: string;
|
|
16980
17048
|
/**
|
|
@@ -17257,6 +17325,8 @@ interface components {
|
|
|
17257
17325
|
key: string;
|
|
17258
17326
|
url: string;
|
|
17259
17327
|
};
|
|
17328
|
+
/** @description Public logo URL derived from the company website. */
|
|
17329
|
+
publicLogoUrl?: string;
|
|
17260
17330
|
/** @description Company name. */
|
|
17261
17331
|
title?: string;
|
|
17262
17332
|
/**
|
|
@@ -17276,6 +17346,11 @@ interface components {
|
|
|
17276
17346
|
surname?: string | null;
|
|
17277
17347
|
};
|
|
17278
17348
|
};
|
|
17349
|
+
/**
|
|
17350
|
+
* Format: uuid
|
|
17351
|
+
* @description ID of the customer the user who created the scheduled transaction belongs to.
|
|
17352
|
+
*/
|
|
17353
|
+
customerRefCreatedBy?: string;
|
|
17279
17354
|
/**
|
|
17280
17355
|
* Format: uuid
|
|
17281
17356
|
* @description Unique identifier of the scheduled transaction.
|
|
@@ -17295,7 +17370,7 @@ interface components {
|
|
|
17295
17370
|
/**
|
|
17296
17371
|
* Format: uuid
|
|
17297
17372
|
* @deprecated
|
|
17298
|
-
* @description Deprecated. Use
|
|
17373
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
17299
17374
|
*/
|
|
17300
17375
|
membershipRefCreator?: string;
|
|
17301
17376
|
/**
|
|
@@ -17522,6 +17597,8 @@ interface components {
|
|
|
17522
17597
|
key: string;
|
|
17523
17598
|
url: string;
|
|
17524
17599
|
};
|
|
17600
|
+
/** @description Public logo URL derived from the company website. */
|
|
17601
|
+
publicLogoUrl?: string;
|
|
17525
17602
|
/** @description Company name. */
|
|
17526
17603
|
title?: string;
|
|
17527
17604
|
/**
|
|
@@ -17541,6 +17618,11 @@ interface components {
|
|
|
17541
17618
|
surname?: string | null;
|
|
17542
17619
|
};
|
|
17543
17620
|
};
|
|
17621
|
+
/**
|
|
17622
|
+
* Format: uuid
|
|
17623
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
17624
|
+
*/
|
|
17625
|
+
customerRefCreatedBy?: string;
|
|
17544
17626
|
/** @description Transaction description. */
|
|
17545
17627
|
description?: string;
|
|
17546
17628
|
/**
|
|
@@ -17562,7 +17644,7 @@ interface components {
|
|
|
17562
17644
|
/**
|
|
17563
17645
|
* Format: uuid
|
|
17564
17646
|
* @deprecated
|
|
17565
|
-
* @description Deprecated. Use
|
|
17647
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
17566
17648
|
*/
|
|
17567
17649
|
membershipRefCreator?: string;
|
|
17568
17650
|
/**
|
|
@@ -17784,6 +17866,8 @@ interface components {
|
|
|
17784
17866
|
key: string;
|
|
17785
17867
|
url: string;
|
|
17786
17868
|
};
|
|
17869
|
+
/** @description Public logo URL derived from the company website. */
|
|
17870
|
+
publicLogoUrl?: string;
|
|
17787
17871
|
/** @description Company name. */
|
|
17788
17872
|
title?: string;
|
|
17789
17873
|
/**
|
|
@@ -17803,6 +17887,11 @@ interface components {
|
|
|
17803
17887
|
surname?: string | null;
|
|
17804
17888
|
};
|
|
17805
17889
|
};
|
|
17890
|
+
/**
|
|
17891
|
+
* Format: uuid
|
|
17892
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
17893
|
+
*/
|
|
17894
|
+
customerRefCreatedBy?: string;
|
|
17806
17895
|
/** @description Transaction description. */
|
|
17807
17896
|
description?: string;
|
|
17808
17897
|
/**
|
|
@@ -17824,7 +17913,7 @@ interface components {
|
|
|
17824
17913
|
/**
|
|
17825
17914
|
* Format: uuid
|
|
17826
17915
|
* @deprecated
|
|
17827
|
-
* @description Deprecated. Use
|
|
17916
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
17828
17917
|
*/
|
|
17829
17918
|
membershipRefCreator?: string;
|
|
17830
17919
|
/**
|
|
@@ -18044,6 +18133,8 @@ interface components {
|
|
|
18044
18133
|
key: string;
|
|
18045
18134
|
url: string;
|
|
18046
18135
|
};
|
|
18136
|
+
/** @description Public logo URL derived from the company website. */
|
|
18137
|
+
publicLogoUrl?: string;
|
|
18047
18138
|
/** @description Company name. */
|
|
18048
18139
|
title?: string;
|
|
18049
18140
|
/**
|
|
@@ -18063,6 +18154,11 @@ interface components {
|
|
|
18063
18154
|
surname?: string | null;
|
|
18064
18155
|
};
|
|
18065
18156
|
};
|
|
18157
|
+
/**
|
|
18158
|
+
* Format: uuid
|
|
18159
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
18160
|
+
*/
|
|
18161
|
+
customerRefCreatedBy?: string;
|
|
18066
18162
|
/** @description Transaction description. */
|
|
18067
18163
|
description?: string;
|
|
18068
18164
|
/**
|
|
@@ -18084,7 +18180,7 @@ interface components {
|
|
|
18084
18180
|
/**
|
|
18085
18181
|
* Format: uuid
|
|
18086
18182
|
* @deprecated
|
|
18087
|
-
* @description Deprecated. Use
|
|
18183
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
18088
18184
|
*/
|
|
18089
18185
|
membershipRefCreator?: string;
|
|
18090
18186
|
/**
|
|
@@ -18193,94 +18289,2139 @@ interface components {
|
|
|
18193
18289
|
*/
|
|
18194
18290
|
userRefOwner?: string;
|
|
18195
18291
|
};
|
|
18196
|
-
|
|
18197
|
-
|
|
18198
|
-
|
|
18199
|
-
|
|
18200
|
-
|
|
18201
|
-
|
|
18202
|
-
|
|
18203
|
-
|
|
18204
|
-
|
|
18205
|
-
|
|
18206
|
-
|
|
18207
|
-
|
|
18208
|
-
|
|
18209
|
-
|
|
18210
|
-
|
|
18211
|
-
|
|
18212
|
-
|
|
18213
|
-
|
|
18214
|
-
|
|
18215
|
-
|
|
18216
|
-
|
|
18217
|
-
|
|
18292
|
+
getMoneyTransactions: {
|
|
18293
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
18294
|
+
nextPageToken?: string;
|
|
18295
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
18296
|
+
searchQueryNext?: string;
|
|
18297
|
+
/** @description List of money transactions. */
|
|
18298
|
+
transactions: {
|
|
18299
|
+
/** @description Transaction amount in major units. */
|
|
18300
|
+
amount: number;
|
|
18301
|
+
/**
|
|
18302
|
+
* @deprecated
|
|
18303
|
+
* @description Deprecated. Use locationAddress instead.
|
|
18304
|
+
*/
|
|
18305
|
+
billingAddressBy?: string;
|
|
18306
|
+
/**
|
|
18307
|
+
* @deprecated
|
|
18308
|
+
* @description Deprecated. Use customerAddress instead.
|
|
18309
|
+
*/
|
|
18310
|
+
billingAddressTo?: string;
|
|
18311
|
+
/**
|
|
18312
|
+
* @deprecated
|
|
18313
|
+
* @description Deprecated. Use product instead.
|
|
18314
|
+
*/
|
|
18315
|
+
booking?: {
|
|
18316
|
+
/**
|
|
18317
|
+
* Format: date-time
|
|
18318
|
+
* @description ISO timestamp of when the booking was deleted.
|
|
18319
|
+
*/
|
|
18320
|
+
deleteDate?: string;
|
|
18321
|
+
/**
|
|
18322
|
+
* Format: date-time
|
|
18323
|
+
* @description Booking end date.
|
|
18324
|
+
*/
|
|
18325
|
+
endDate?: string;
|
|
18326
|
+
/**
|
|
18327
|
+
* Format: uuid
|
|
18328
|
+
* @description Booking id.
|
|
18329
|
+
*/
|
|
18330
|
+
id: string;
|
|
18331
|
+
/**
|
|
18332
|
+
* Format: uuid
|
|
18333
|
+
* @description Membership of the user who deleted the booking.
|
|
18334
|
+
*/
|
|
18335
|
+
membershipRefDeletedBy?: string;
|
|
18336
|
+
/**
|
|
18337
|
+
* @deprecated
|
|
18338
|
+
* @description Booking price.
|
|
18339
|
+
*/
|
|
18340
|
+
price: {
|
|
18341
|
+
/** @description Amount excluding tax in major units. */
|
|
18342
|
+
netAmount: number;
|
|
18343
|
+
/** @description Tax amount in major units. */
|
|
18344
|
+
taxAmount?: number;
|
|
18345
|
+
};
|
|
18346
|
+
/** @description Booked resource. */
|
|
18347
|
+
resource: {
|
|
18348
|
+
/**
|
|
18349
|
+
* Format: uuid
|
|
18350
|
+
* @description Resource id.
|
|
18351
|
+
*/
|
|
18352
|
+
id: string;
|
|
18353
|
+
/** @description Resource title. */
|
|
18354
|
+
title: string;
|
|
18355
|
+
};
|
|
18356
|
+
/**
|
|
18357
|
+
* Format: date-time
|
|
18358
|
+
* @description Booking start date.
|
|
18359
|
+
*/
|
|
18360
|
+
startDate?: string;
|
|
18361
|
+
/** @description User who deleted the booking. */
|
|
18362
|
+
userDeletedBy?: {
|
|
18363
|
+
about?: string | null;
|
|
18364
|
+
email?: string | null;
|
|
18365
|
+
/** Format: uuid */
|
|
18366
|
+
id: string;
|
|
18367
|
+
name?: string | null;
|
|
18368
|
+
phoneNumber?: string | null;
|
|
18369
|
+
photoUrl?: string | null;
|
|
18370
|
+
surname?: string | null;
|
|
18371
|
+
};
|
|
18218
18372
|
};
|
|
18219
|
-
|
|
18220
|
-
|
|
18221
|
-
|
|
18222
|
-
|
|
18223
|
-
|
|
18224
|
-
|
|
18225
|
-
|
|
18226
|
-
|
|
18227
|
-
|
|
18228
|
-
|
|
18229
|
-
|
|
18230
|
-
|
|
18231
|
-
|
|
18232
|
-
|
|
18233
|
-
|
|
18234
|
-
|
|
18235
|
-
|
|
18236
|
-
|
|
18237
|
-
|
|
18238
|
-
|
|
18373
|
+
/**
|
|
18374
|
+
* @deprecated
|
|
18375
|
+
* @description Deprecated. Use customer instead.
|
|
18376
|
+
*/
|
|
18377
|
+
company?: {
|
|
18378
|
+
/**
|
|
18379
|
+
* Format: date-time
|
|
18380
|
+
* @description ISO timestamp of company creation.
|
|
18381
|
+
*/
|
|
18382
|
+
createDate: string;
|
|
18383
|
+
/**
|
|
18384
|
+
* Format: uuid
|
|
18385
|
+
* @description Company id.
|
|
18386
|
+
*/
|
|
18387
|
+
id: string;
|
|
18388
|
+
/**
|
|
18389
|
+
* Format: uuid
|
|
18390
|
+
* @description Location id.
|
|
18391
|
+
*/
|
|
18392
|
+
locationRef: string;
|
|
18393
|
+
/** @description Company metadata. */
|
|
18394
|
+
metadata?: {
|
|
18395
|
+
[key: string]: unknown;
|
|
18396
|
+
};
|
|
18397
|
+
/** @description Internal notes. */
|
|
18398
|
+
notes?: string;
|
|
18399
|
+
/**
|
|
18400
|
+
* Format: uuid
|
|
18401
|
+
* @description Primary subscription id.
|
|
18402
|
+
*/
|
|
18403
|
+
subscriptionRef: string | null;
|
|
18404
|
+
/** @description Company name. */
|
|
18405
|
+
title: string;
|
|
18239
18406
|
};
|
|
18240
|
-
|
|
18241
|
-
|
|
18242
|
-
|
|
18407
|
+
/**
|
|
18408
|
+
* Format: uuid
|
|
18409
|
+
* @deprecated
|
|
18410
|
+
* @description Deprecated. Use customer instead.
|
|
18411
|
+
*/
|
|
18412
|
+
companyRef?: string;
|
|
18413
|
+
/**
|
|
18414
|
+
* Format: date-time
|
|
18415
|
+
* @description ISO timestamp of when the transaction was created.
|
|
18416
|
+
*/
|
|
18417
|
+
createDate: string;
|
|
18418
|
+
/**
|
|
18419
|
+
* @deprecated
|
|
18420
|
+
* @description Deprecated. Use product instead.
|
|
18421
|
+
*/
|
|
18422
|
+
creditPackage?: {
|
|
18423
|
+
/** @description Credits amount of the package, or the package price when the package has no credits. */
|
|
18424
|
+
amount: number;
|
|
18425
|
+
/** @description Credits amount of the package. */
|
|
18426
|
+
creditsAmount?: number;
|
|
18427
|
+
/** @description Day passes amount of the package. */
|
|
18428
|
+
dayPassesAmount?: number;
|
|
18429
|
+
/**
|
|
18430
|
+
* @deprecated
|
|
18431
|
+
* @description Package price.
|
|
18432
|
+
*/
|
|
18433
|
+
price: {
|
|
18434
|
+
/** @description Amount excluding tax in major units. */
|
|
18435
|
+
netAmount: number;
|
|
18436
|
+
/** @description Tax amount in major units. */
|
|
18437
|
+
taxAmount?: number;
|
|
18438
|
+
};
|
|
18243
18439
|
};
|
|
18244
|
-
|
|
18245
|
-
|
|
18246
|
-
|
|
18440
|
+
/** @description ISO currency code. */
|
|
18441
|
+
currencyCode: string;
|
|
18442
|
+
/** @description Customer associated with this transaction. */
|
|
18443
|
+
customer?: {
|
|
18444
|
+
/**
|
|
18445
|
+
* Format: uuid
|
|
18446
|
+
* @description ID of the company or user.
|
|
18447
|
+
*/
|
|
18448
|
+
id: string;
|
|
18449
|
+
/** @description Company logo. */
|
|
18450
|
+
logo?: {
|
|
18451
|
+
key: string;
|
|
18452
|
+
url: string;
|
|
18453
|
+
};
|
|
18454
|
+
/** @description Public logo URL derived from the company website. */
|
|
18455
|
+
publicLogoUrl?: string;
|
|
18456
|
+
/** @description Company name. */
|
|
18247
18457
|
title?: string;
|
|
18248
|
-
|
|
18249
|
-
|
|
18250
|
-
|
|
18251
|
-
|
|
18252
|
-
|
|
18253
|
-
|
|
18254
|
-
|
|
18255
|
-
|
|
18256
|
-
|
|
18257
|
-
|
|
18258
|
-
|
|
18259
|
-
|
|
18260
|
-
|
|
18261
|
-
|
|
18262
|
-
|
|
18263
|
-
|
|
18264
|
-
|
|
18265
|
-
|
|
18266
|
-
|
|
18267
|
-
|
|
18268
|
-
|
|
18269
|
-
|
|
18270
|
-
|
|
18271
|
-
|
|
18458
|
+
/**
|
|
18459
|
+
* @description Whether the customer is a company or a user.
|
|
18460
|
+
* @enum {string}
|
|
18461
|
+
*/
|
|
18462
|
+
type: "company" | "user";
|
|
18463
|
+
/** @description User details for user customers. */
|
|
18464
|
+
user?: {
|
|
18465
|
+
about?: string | null;
|
|
18466
|
+
email?: string | null;
|
|
18467
|
+
/** Format: uuid */
|
|
18468
|
+
id: string;
|
|
18469
|
+
name?: string | null;
|
|
18470
|
+
phoneNumber?: string | null;
|
|
18471
|
+
photoUrl?: string | null;
|
|
18472
|
+
surname?: string | null;
|
|
18473
|
+
};
|
|
18474
|
+
};
|
|
18475
|
+
/**
|
|
18476
|
+
* Format: uuid
|
|
18477
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
18478
|
+
*/
|
|
18479
|
+
customerRefCreatedBy?: string;
|
|
18480
|
+
/** @description Customer billing address. */
|
|
18481
|
+
customerAddress?: {
|
|
18482
|
+
city: string;
|
|
18483
|
+
countryCode: string | null;
|
|
18484
|
+
line1: string;
|
|
18485
|
+
line2: string;
|
|
18486
|
+
postalCode: string;
|
|
18487
|
+
state: string;
|
|
18488
|
+
};
|
|
18489
|
+
/** @description Customer legal name. */
|
|
18490
|
+
customerName?: string;
|
|
18491
|
+
/** @description Customer tax ID. */
|
|
18492
|
+
customerTaxId?: string;
|
|
18493
|
+
/** @description Custom item details. */
|
|
18494
|
+
customItem?: {
|
|
18495
|
+
/** @description Custom item currency code. */
|
|
18496
|
+
currencyCode?: string;
|
|
18497
|
+
/** @description Custom item description. */
|
|
18498
|
+
description?: string;
|
|
18499
|
+
tax?: {
|
|
18500
|
+
/** @description Whether tax is enabled for the custom item. */
|
|
18501
|
+
enabled: boolean;
|
|
18502
|
+
/** @description Tax rate. */
|
|
18503
|
+
rate: number;
|
|
18504
|
+
};
|
|
18505
|
+
/** @description Custom item unit amount in major units. */
|
|
18506
|
+
unitAmount?: number;
|
|
18507
|
+
/** @description Custom item unit quantity. */
|
|
18508
|
+
unitQuantity?: number;
|
|
18509
|
+
};
|
|
18510
|
+
/** @description Discounts applied to the transaction. */
|
|
18511
|
+
discounts?: {
|
|
18512
|
+
/** @description Applied coupon. */
|
|
18513
|
+
coupon: {
|
|
18514
|
+
/** @description Fixed amount discount. */
|
|
18515
|
+
amountOff?: number;
|
|
18516
|
+
/** @description Currency of the fixed amount discount. */
|
|
18517
|
+
currencyCode?: string;
|
|
18518
|
+
/** @description Coupon id. */
|
|
18519
|
+
id?: string;
|
|
18520
|
+
/** @description Percentage discount. */
|
|
18521
|
+
percentOff?: number;
|
|
18522
|
+
/** @description Product types the coupon applies to. */
|
|
18523
|
+
productTypes?: string[];
|
|
18524
|
+
/** @description Coupon type. */
|
|
18525
|
+
type?: string;
|
|
18526
|
+
};
|
|
18527
|
+
/** @description Promocode the coupon was applied with. */
|
|
18528
|
+
promocode?: {
|
|
18529
|
+
/** @description Promocode. */
|
|
18530
|
+
code: string;
|
|
18531
|
+
/** @description Promocode expiration settings. */
|
|
18532
|
+
expiration?: {
|
|
18533
|
+
/**
|
|
18534
|
+
* Format: date-time
|
|
18535
|
+
* @description ISO timestamp when the promocode expires.
|
|
18536
|
+
*/
|
|
18537
|
+
date?: string;
|
|
18538
|
+
/** @description Whether the promocode has an expiration date. */
|
|
18539
|
+
enabled: boolean;
|
|
18540
|
+
};
|
|
18541
|
+
/**
|
|
18542
|
+
* Format: uuid
|
|
18543
|
+
* @description Promocode id.
|
|
18544
|
+
*/
|
|
18545
|
+
id: string;
|
|
18546
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
18547
|
+
limitByFirstPurchase?: boolean;
|
|
18548
|
+
};
|
|
18549
|
+
/**
|
|
18550
|
+
* Format: uuid
|
|
18551
|
+
* @description ID of the subscription this discount is associated with.
|
|
18552
|
+
*/
|
|
18553
|
+
subscriptionId?: string;
|
|
18554
|
+
}[];
|
|
18555
|
+
/** @description Payment gateway error description for failed transactions. */
|
|
18556
|
+
errorDescription?: string;
|
|
18557
|
+
/**
|
|
18558
|
+
* Format: uuid
|
|
18559
|
+
* @description Unique identifier of the transaction.
|
|
18560
|
+
*/
|
|
18561
|
+
id: string;
|
|
18562
|
+
/**
|
|
18563
|
+
* @deprecated
|
|
18564
|
+
* @description Deprecated. Use product instead.
|
|
18565
|
+
*/
|
|
18566
|
+
invoice?: {
|
|
18567
|
+
/**
|
|
18568
|
+
* Format: uuid
|
|
18569
|
+
* @description Invoice id.
|
|
18570
|
+
*/
|
|
18571
|
+
id: string;
|
|
18572
|
+
/** @description Invoice title. */
|
|
18573
|
+
title: string;
|
|
18574
|
+
};
|
|
18575
|
+
/** @description Location billing address. */
|
|
18576
|
+
locationAddress?: {
|
|
18577
|
+
city: string;
|
|
18578
|
+
countryCode: string | null;
|
|
18579
|
+
line1: string;
|
|
18580
|
+
line2: string;
|
|
18581
|
+
postalCode: string;
|
|
18582
|
+
state: string;
|
|
18583
|
+
};
|
|
18584
|
+
/** @description Location legal name. */
|
|
18585
|
+
locationName?: string;
|
|
18586
|
+
/**
|
|
18587
|
+
* Format: uuid
|
|
18588
|
+
* @description ID of the organization (location).
|
|
18589
|
+
*/
|
|
18590
|
+
locationRef: string;
|
|
18591
|
+
/** @description Location tax ID. */
|
|
18592
|
+
locationTaxId?: string;
|
|
18593
|
+
/**
|
|
18594
|
+
* Format: uuid
|
|
18595
|
+
* @deprecated
|
|
18596
|
+
* @description Deprecated. Use customer instead.
|
|
18597
|
+
*/
|
|
18598
|
+
membershipRef?: string;
|
|
18599
|
+
/**
|
|
18600
|
+
* Format: uuid
|
|
18601
|
+
* @deprecated
|
|
18602
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
18603
|
+
*/
|
|
18604
|
+
membershipRefCreator?: string;
|
|
18605
|
+
/**
|
|
18606
|
+
* Format: uuid
|
|
18607
|
+
* @description ID of the network.
|
|
18608
|
+
*/
|
|
18609
|
+
networkRef: string;
|
|
18610
|
+
/**
|
|
18611
|
+
* @deprecated
|
|
18612
|
+
* @description Deprecated. Use product instead.
|
|
18613
|
+
*/
|
|
18614
|
+
order?: {
|
|
18615
|
+
/**
|
|
18616
|
+
* Format: uuid
|
|
18617
|
+
* @description Order id.
|
|
18618
|
+
*/
|
|
18619
|
+
id: string;
|
|
18620
|
+
/** @description Order items. */
|
|
18621
|
+
items: {
|
|
18622
|
+
/**
|
|
18623
|
+
* Format: uuid
|
|
18624
|
+
* @description Order item id.
|
|
18625
|
+
*/
|
|
18626
|
+
id: string;
|
|
18627
|
+
/** @description Ordered product. */
|
|
18628
|
+
product: {
|
|
18629
|
+
/**
|
|
18630
|
+
* Format: uuid
|
|
18631
|
+
* @description Product id.
|
|
18632
|
+
*/
|
|
18633
|
+
id: string;
|
|
18634
|
+
/** @description Product option. */
|
|
18635
|
+
option?: {
|
|
18636
|
+
/**
|
|
18637
|
+
* Format: uuid
|
|
18638
|
+
* @description Product option id.
|
|
18639
|
+
*/
|
|
18640
|
+
id: string;
|
|
18641
|
+
/** @description Product option title. */
|
|
18642
|
+
title: string;
|
|
18643
|
+
};
|
|
18644
|
+
/** @description Product title. */
|
|
18645
|
+
title: string;
|
|
18646
|
+
};
|
|
18647
|
+
/** @description Quantity of units. */
|
|
18648
|
+
quantity: number;
|
|
18649
|
+
}[];
|
|
18650
|
+
};
|
|
18651
|
+
/** @description Payment details. */
|
|
18652
|
+
payment: {
|
|
18653
|
+
/** @description Payment dispute details. */
|
|
18654
|
+
dispute?: {
|
|
18655
|
+
/**
|
|
18656
|
+
* Format: date-time
|
|
18657
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
18658
|
+
*/
|
|
18659
|
+
createDate: string;
|
|
18660
|
+
};
|
|
18661
|
+
/** @description Payment method used. */
|
|
18662
|
+
method: {
|
|
18663
|
+
/** @description Present when type is external. */
|
|
18664
|
+
external?: Record<string, never>;
|
|
18665
|
+
/** @description Present when type is paymentGateway. */
|
|
18666
|
+
paymentGateway?: {
|
|
18667
|
+
/** @description Payment gateway identifier. */
|
|
18668
|
+
gateway: string;
|
|
18669
|
+
/** @description Display label for the payment method. */
|
|
18670
|
+
label?: string;
|
|
18671
|
+
/** @description Masked card or account identifier. */
|
|
18672
|
+
mask?: string;
|
|
18673
|
+
/** @description Display title for the payment gateway. */
|
|
18674
|
+
title?: string;
|
|
18675
|
+
};
|
|
18676
|
+
/**
|
|
18677
|
+
* @description Payment method type.
|
|
18678
|
+
* @enum {string}
|
|
18679
|
+
*/
|
|
18680
|
+
type: "external" | "paymentGateway";
|
|
18681
|
+
};
|
|
18682
|
+
/** @description Payment price details. */
|
|
18683
|
+
price: {
|
|
18684
|
+
money: {
|
|
18685
|
+
/** @description ISO currency code. */
|
|
18686
|
+
currencyCode: string;
|
|
18687
|
+
/** @description Payment amount in major units. */
|
|
18688
|
+
grossAmount: number;
|
|
18689
|
+
};
|
|
18690
|
+
/** @enum {string} */
|
|
18691
|
+
type: "money";
|
|
18692
|
+
};
|
|
18693
|
+
/** @description Whether this payment can be refunded. */
|
|
18694
|
+
refundable: boolean;
|
|
18695
|
+
/** @description Refunds issued against this payment. */
|
|
18696
|
+
refunds?: {
|
|
18697
|
+
money: {
|
|
18698
|
+
/**
|
|
18699
|
+
* Format: date-time
|
|
18700
|
+
* @description Refund creation timestamp.
|
|
18701
|
+
*/
|
|
18702
|
+
createDate: string;
|
|
18703
|
+
/** @description ISO currency code. */
|
|
18704
|
+
currencyCode: string;
|
|
18705
|
+
/**
|
|
18706
|
+
* Format: uuid
|
|
18707
|
+
* @description ID of the customer the user who created the refund belongs to.
|
|
18708
|
+
*/
|
|
18709
|
+
customerRefCreatedBy?: string;
|
|
18710
|
+
/** @description Refunded amount in major units. */
|
|
18711
|
+
grossAmount: number;
|
|
18712
|
+
/**
|
|
18713
|
+
* Format: uuid
|
|
18714
|
+
* @description Refund id.
|
|
18715
|
+
*/
|
|
18716
|
+
id: string;
|
|
18717
|
+
/** @description Who initiated the refund: `spacebring` for a refund issued in Spacebring, `stripe` for one issued in the Stripe dashboard. */
|
|
18718
|
+
initiator?: string;
|
|
18719
|
+
/** @description User who created the refund. */
|
|
18720
|
+
userCreatedBy?: {
|
|
18721
|
+
about?: string | null;
|
|
18722
|
+
email?: string | null;
|
|
18723
|
+
/** Format: uuid */
|
|
18724
|
+
id: string;
|
|
18725
|
+
name?: string | null;
|
|
18726
|
+
phoneNumber?: string | null;
|
|
18727
|
+
photoUrl?: string | null;
|
|
18728
|
+
surname?: string | null;
|
|
18729
|
+
};
|
|
18730
|
+
}[];
|
|
18731
|
+
/** @enum {string} */
|
|
18732
|
+
type: "money";
|
|
18733
|
+
};
|
|
18734
|
+
/** @description Payment surcharge details. */
|
|
18735
|
+
surcharge?: {
|
|
18736
|
+
money: {
|
|
18737
|
+
/** @description Surcharge amount in major units. */
|
|
18738
|
+
amount: number;
|
|
18739
|
+
/** @description ISO currency code. */
|
|
18740
|
+
currencyCode: string;
|
|
18741
|
+
/** @description Surcharge percentage. */
|
|
18742
|
+
percentage?: number;
|
|
18743
|
+
/** @description Surcharge rate. */
|
|
18744
|
+
rate?: number;
|
|
18745
|
+
};
|
|
18746
|
+
/** @enum {string} */
|
|
18747
|
+
type: "money";
|
|
18748
|
+
};
|
|
18749
|
+
};
|
|
18750
|
+
/**
|
|
18751
|
+
* @deprecated
|
|
18752
|
+
* @description Deprecated. Use payment.method instead.
|
|
18753
|
+
*/
|
|
18754
|
+
paymentMethod: {
|
|
18755
|
+
/** @description Display label of the payment method. */
|
|
18756
|
+
label?: string;
|
|
18757
|
+
/** @description Payment gateway identifier, or external. */
|
|
18758
|
+
type: string;
|
|
18759
|
+
};
|
|
18760
|
+
/**
|
|
18761
|
+
* @deprecated
|
|
18762
|
+
* @description Deprecated. Use product instead.
|
|
18763
|
+
*/
|
|
18764
|
+
plan?: {
|
|
18765
|
+
/**
|
|
18766
|
+
* Format: uuid
|
|
18767
|
+
* @description Plan id.
|
|
18768
|
+
*/
|
|
18769
|
+
id: string;
|
|
18770
|
+
/** @description Plan title. */
|
|
18771
|
+
title: string;
|
|
18772
|
+
};
|
|
18773
|
+
/** @description Product details. */
|
|
18774
|
+
product?: {
|
|
18775
|
+
/**
|
|
18776
|
+
* Format: uuid
|
|
18777
|
+
* @description ID of the associated booking.
|
|
18778
|
+
*/
|
|
18779
|
+
bookingRef?: string;
|
|
18780
|
+
/**
|
|
18781
|
+
* Format: uuid
|
|
18782
|
+
* @description ID of the associated event ticket.
|
|
18783
|
+
*/
|
|
18784
|
+
eventTicketRef?: string;
|
|
18785
|
+
/**
|
|
18786
|
+
* Format: uuid
|
|
18787
|
+
* @description ID of the associated invoice.
|
|
18788
|
+
*/
|
|
18789
|
+
invoiceRef?: string;
|
|
18790
|
+
/**
|
|
18791
|
+
* Format: uuid
|
|
18792
|
+
* @description ID of the associated order.
|
|
18793
|
+
*/
|
|
18794
|
+
orderRef?: string;
|
|
18795
|
+
/**
|
|
18796
|
+
* Format: uuid
|
|
18797
|
+
* @description ID of the associated subscription.
|
|
18798
|
+
*/
|
|
18799
|
+
subscriptionRef?: string;
|
|
18800
|
+
/** @description Display title of the product. */
|
|
18801
|
+
title?: string;
|
|
18802
|
+
/**
|
|
18803
|
+
* @description Product type.
|
|
18804
|
+
* @enum {string}
|
|
18805
|
+
*/
|
|
18806
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
18807
|
+
};
|
|
18808
|
+
/** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
|
|
18809
|
+
receiptPdfUrl?: string;
|
|
18810
|
+
/**
|
|
18811
|
+
* @deprecated
|
|
18812
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
18813
|
+
*/
|
|
18814
|
+
refund?: {
|
|
18815
|
+
/** @description Refunded amount. */
|
|
18816
|
+
amount: number;
|
|
18817
|
+
/**
|
|
18818
|
+
* Format: date-time
|
|
18819
|
+
* @description Refund creation timestamp.
|
|
18820
|
+
*/
|
|
18821
|
+
createDate: string;
|
|
18822
|
+
};
|
|
18823
|
+
/**
|
|
18824
|
+
* @deprecated
|
|
18825
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
18826
|
+
*/
|
|
18827
|
+
refunds?: {
|
|
18828
|
+
/** @description Refunded amount. */
|
|
18829
|
+
amount: number;
|
|
18830
|
+
/**
|
|
18831
|
+
* Format: date-time
|
|
18832
|
+
* @description Refund creation timestamp.
|
|
18833
|
+
*/
|
|
18834
|
+
createDate: string;
|
|
18835
|
+
/** @description ISO currency code. */
|
|
18836
|
+
currencyCode?: string;
|
|
18837
|
+
/**
|
|
18838
|
+
* Format: uuid
|
|
18839
|
+
* @description Refund id.
|
|
18840
|
+
*/
|
|
18841
|
+
id?: string;
|
|
18842
|
+
/** @description Refund initiator. */
|
|
18843
|
+
initiator?: string;
|
|
18844
|
+
/**
|
|
18845
|
+
* Format: uuid
|
|
18846
|
+
* @description Membership of the user who created the refund.
|
|
18847
|
+
*/
|
|
18848
|
+
membershipRefCreator?: string;
|
|
18849
|
+
/**
|
|
18850
|
+
* Format: uuid
|
|
18851
|
+
* @description Location id.
|
|
18852
|
+
*/
|
|
18853
|
+
organizationRef: string;
|
|
18854
|
+
/** @description User who created the refund. */
|
|
18855
|
+
userCreator?: {
|
|
18856
|
+
about?: string | null;
|
|
18857
|
+
email?: string | null;
|
|
18858
|
+
/** Format: uuid */
|
|
18859
|
+
id: string;
|
|
18860
|
+
name?: string | null;
|
|
18861
|
+
phoneNumber?: string | null;
|
|
18862
|
+
photoUrl?: string | null;
|
|
18863
|
+
surname?: string | null;
|
|
18864
|
+
};
|
|
18865
|
+
/**
|
|
18866
|
+
* Format: uuid
|
|
18867
|
+
* @description User id of the refund creator.
|
|
18868
|
+
*/
|
|
18869
|
+
userRefCreator?: string;
|
|
18870
|
+
}[];
|
|
18871
|
+
/**
|
|
18872
|
+
* @description Transaction status.
|
|
18873
|
+
* @enum {string}
|
|
18874
|
+
*/
|
|
18875
|
+
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
|
|
18876
|
+
/**
|
|
18877
|
+
* @deprecated
|
|
18878
|
+
* @description Deprecated. Use product instead.
|
|
18879
|
+
*/
|
|
18880
|
+
ticket?: {
|
|
18881
|
+
/**
|
|
18882
|
+
* Format: date-time
|
|
18883
|
+
* @description Ticket creation timestamp.
|
|
18884
|
+
*/
|
|
18885
|
+
createDate?: string;
|
|
18886
|
+
/**
|
|
18887
|
+
* Format: date-time
|
|
18888
|
+
* @description ISO timestamp of when the ticket was deleted.
|
|
18889
|
+
*/
|
|
18890
|
+
deleteDate?: string;
|
|
18891
|
+
/** @description Event details. */
|
|
18892
|
+
event?: {
|
|
18893
|
+
/**
|
|
18894
|
+
* Format: date-time
|
|
18895
|
+
* @description Event end date.
|
|
18896
|
+
*/
|
|
18897
|
+
endDate?: string;
|
|
18898
|
+
/**
|
|
18899
|
+
* Format: uuid
|
|
18900
|
+
* @description Event id.
|
|
18901
|
+
*/
|
|
18902
|
+
id: string;
|
|
18903
|
+
/**
|
|
18904
|
+
* Format: date-time
|
|
18905
|
+
* @description Event start date.
|
|
18906
|
+
*/
|
|
18907
|
+
startDate?: string;
|
|
18908
|
+
/** @description Event title. */
|
|
18909
|
+
title: string;
|
|
18910
|
+
};
|
|
18911
|
+
/**
|
|
18912
|
+
* Format: uuid
|
|
18913
|
+
* @description Ticket id.
|
|
18914
|
+
*/
|
|
18915
|
+
id: string;
|
|
18916
|
+
/**
|
|
18917
|
+
* Format: uuid
|
|
18918
|
+
* @description Membership of the user who deleted the ticket.
|
|
18919
|
+
*/
|
|
18920
|
+
membershipRefDeletedBy?: string;
|
|
18921
|
+
/**
|
|
18922
|
+
* @deprecated
|
|
18923
|
+
* @description Ticket price.
|
|
18924
|
+
*/
|
|
18925
|
+
price: {
|
|
18926
|
+
/** @description Amount excluding tax in major units. */
|
|
18927
|
+
netAmount: number;
|
|
18928
|
+
/** @description Tax amount in major units. */
|
|
18929
|
+
taxAmount?: number;
|
|
18930
|
+
};
|
|
18931
|
+
/** @description Number of tickets. */
|
|
18932
|
+
quantity: number;
|
|
18933
|
+
/** @description User who deleted the ticket. */
|
|
18934
|
+
userDeletedBy?: {
|
|
18935
|
+
about?: string | null;
|
|
18936
|
+
email?: string | null;
|
|
18937
|
+
/** Format: uuid */
|
|
18938
|
+
id: string;
|
|
18939
|
+
name?: string | null;
|
|
18940
|
+
phoneNumber?: string | null;
|
|
18941
|
+
photoUrl?: string | null;
|
|
18942
|
+
surname?: string | null;
|
|
18943
|
+
};
|
|
18944
|
+
};
|
|
18945
|
+
/**
|
|
18946
|
+
* @description Money transaction type.
|
|
18947
|
+
* @enum {string}
|
|
18948
|
+
*/
|
|
18949
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
18950
|
+
/**
|
|
18951
|
+
* @deprecated
|
|
18952
|
+
* @description Deprecated. Use customer.user instead.
|
|
18953
|
+
*/
|
|
18954
|
+
user?: {
|
|
18955
|
+
about?: string | null;
|
|
18956
|
+
email?: string | null;
|
|
18957
|
+
/** Format: uuid */
|
|
18958
|
+
id: string;
|
|
18959
|
+
name?: string | null;
|
|
18960
|
+
phoneNumber?: string | null;
|
|
18961
|
+
photoUrl?: string | null;
|
|
18962
|
+
surname?: string | null;
|
|
18963
|
+
};
|
|
18964
|
+
/** @description User who created the transaction. */
|
|
18965
|
+
userCreatedBy?: {
|
|
18966
|
+
about?: string | null;
|
|
18967
|
+
email?: string | null;
|
|
18968
|
+
/** Format: uuid */
|
|
18969
|
+
id: string;
|
|
18970
|
+
name?: string | null;
|
|
18971
|
+
phoneNumber?: string | null;
|
|
18972
|
+
photoUrl?: string | null;
|
|
18973
|
+
surname?: string | null;
|
|
18974
|
+
};
|
|
18975
|
+
/**
|
|
18976
|
+
* @deprecated
|
|
18977
|
+
* @description Deprecated. Use customer.user instead.
|
|
18978
|
+
*/
|
|
18979
|
+
userOwner?: {
|
|
18980
|
+
about?: string | null;
|
|
18981
|
+
email?: string | null;
|
|
18272
18982
|
/** Format: uuid */
|
|
18983
|
+
id: string;
|
|
18984
|
+
name?: string | null;
|
|
18985
|
+
phoneNumber?: string | null;
|
|
18986
|
+
photoUrl?: string | null;
|
|
18987
|
+
surname?: string | null;
|
|
18988
|
+
};
|
|
18989
|
+
/**
|
|
18990
|
+
* Format: uuid
|
|
18991
|
+
* @deprecated
|
|
18992
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
18993
|
+
*/
|
|
18994
|
+
userRefCreator?: string;
|
|
18995
|
+
/**
|
|
18996
|
+
* Format: uuid
|
|
18997
|
+
* @deprecated
|
|
18998
|
+
* @description Deprecated. Use customer.user instead.
|
|
18999
|
+
*/
|
|
19000
|
+
userRefOwner?: string;
|
|
19001
|
+
}[];
|
|
19002
|
+
};
|
|
19003
|
+
createMoneyTransaction: {
|
|
19004
|
+
/** @description The created money transaction. */
|
|
19005
|
+
transaction: {
|
|
19006
|
+
/** @description Transaction amount in major units. */
|
|
19007
|
+
amount: number;
|
|
19008
|
+
/**
|
|
19009
|
+
* @deprecated
|
|
19010
|
+
* @description Deprecated. Use locationAddress instead.
|
|
19011
|
+
*/
|
|
19012
|
+
billingAddressBy?: string;
|
|
19013
|
+
/**
|
|
19014
|
+
* @deprecated
|
|
19015
|
+
* @description Deprecated. Use customerAddress instead.
|
|
19016
|
+
*/
|
|
19017
|
+
billingAddressTo?: string;
|
|
19018
|
+
/**
|
|
19019
|
+
* @deprecated
|
|
19020
|
+
* @description Deprecated. Use product instead.
|
|
19021
|
+
*/
|
|
19022
|
+
booking?: {
|
|
19023
|
+
/**
|
|
19024
|
+
* Format: date-time
|
|
19025
|
+
* @description ISO timestamp of when the booking was deleted.
|
|
19026
|
+
*/
|
|
19027
|
+
deleteDate?: string;
|
|
19028
|
+
/**
|
|
19029
|
+
* Format: date-time
|
|
19030
|
+
* @description Booking end date.
|
|
19031
|
+
*/
|
|
19032
|
+
endDate?: string;
|
|
19033
|
+
/**
|
|
19034
|
+
* Format: uuid
|
|
19035
|
+
* @description Booking id.
|
|
19036
|
+
*/
|
|
19037
|
+
id: string;
|
|
19038
|
+
/**
|
|
19039
|
+
* Format: uuid
|
|
19040
|
+
* @description Membership of the user who deleted the booking.
|
|
19041
|
+
*/
|
|
19042
|
+
membershipRefDeletedBy?: string;
|
|
19043
|
+
/**
|
|
19044
|
+
* @deprecated
|
|
19045
|
+
* @description Booking price.
|
|
19046
|
+
*/
|
|
19047
|
+
price: {
|
|
19048
|
+
/** @description Amount excluding tax in major units. */
|
|
19049
|
+
netAmount: number;
|
|
19050
|
+
/** @description Tax amount in major units. */
|
|
19051
|
+
taxAmount?: number;
|
|
19052
|
+
};
|
|
19053
|
+
/** @description Booked resource. */
|
|
19054
|
+
resource: {
|
|
19055
|
+
/**
|
|
19056
|
+
* Format: uuid
|
|
19057
|
+
* @description Resource id.
|
|
19058
|
+
*/
|
|
19059
|
+
id: string;
|
|
19060
|
+
/** @description Resource title. */
|
|
19061
|
+
title: string;
|
|
19062
|
+
};
|
|
19063
|
+
/**
|
|
19064
|
+
* Format: date-time
|
|
19065
|
+
* @description Booking start date.
|
|
19066
|
+
*/
|
|
19067
|
+
startDate?: string;
|
|
19068
|
+
/** @description User who deleted the booking. */
|
|
19069
|
+
userDeletedBy?: {
|
|
19070
|
+
about?: string | null;
|
|
19071
|
+
email?: string | null;
|
|
19072
|
+
/** Format: uuid */
|
|
19073
|
+
id: string;
|
|
19074
|
+
name?: string | null;
|
|
19075
|
+
phoneNumber?: string | null;
|
|
19076
|
+
photoUrl?: string | null;
|
|
19077
|
+
surname?: string | null;
|
|
19078
|
+
};
|
|
19079
|
+
};
|
|
19080
|
+
/**
|
|
19081
|
+
* @deprecated
|
|
19082
|
+
* @description Deprecated. Use customer instead.
|
|
19083
|
+
*/
|
|
19084
|
+
company?: {
|
|
19085
|
+
/**
|
|
19086
|
+
* Format: date-time
|
|
19087
|
+
* @description ISO timestamp of company creation.
|
|
19088
|
+
*/
|
|
19089
|
+
createDate: string;
|
|
19090
|
+
/**
|
|
19091
|
+
* Format: uuid
|
|
19092
|
+
* @description Company id.
|
|
19093
|
+
*/
|
|
19094
|
+
id: string;
|
|
19095
|
+
/**
|
|
19096
|
+
* Format: uuid
|
|
19097
|
+
* @description Location id.
|
|
19098
|
+
*/
|
|
19099
|
+
locationRef: string;
|
|
19100
|
+
/** @description Company metadata. */
|
|
19101
|
+
metadata?: {
|
|
19102
|
+
[key: string]: unknown;
|
|
19103
|
+
};
|
|
19104
|
+
/** @description Internal notes. */
|
|
19105
|
+
notes?: string;
|
|
19106
|
+
/**
|
|
19107
|
+
* Format: uuid
|
|
19108
|
+
* @description Primary subscription id.
|
|
19109
|
+
*/
|
|
19110
|
+
subscriptionRef: string | null;
|
|
19111
|
+
/** @description Company name. */
|
|
19112
|
+
title: string;
|
|
19113
|
+
};
|
|
19114
|
+
/**
|
|
19115
|
+
* Format: uuid
|
|
19116
|
+
* @deprecated
|
|
19117
|
+
* @description Deprecated. Use customer instead.
|
|
19118
|
+
*/
|
|
19119
|
+
companyRef?: string;
|
|
19120
|
+
/**
|
|
19121
|
+
* Format: date-time
|
|
19122
|
+
* @description ISO timestamp of when the transaction was created.
|
|
19123
|
+
*/
|
|
19124
|
+
createDate: string;
|
|
19125
|
+
/**
|
|
19126
|
+
* @deprecated
|
|
19127
|
+
* @description Deprecated. Use product instead.
|
|
19128
|
+
*/
|
|
19129
|
+
creditPackage?: {
|
|
19130
|
+
/** @description Credits amount of the package, or the package price when the package has no credits. */
|
|
19131
|
+
amount: number;
|
|
19132
|
+
/** @description Credits amount of the package. */
|
|
19133
|
+
creditsAmount?: number;
|
|
19134
|
+
/** @description Day passes amount of the package. */
|
|
19135
|
+
dayPassesAmount?: number;
|
|
19136
|
+
/**
|
|
19137
|
+
* @deprecated
|
|
19138
|
+
* @description Package price.
|
|
19139
|
+
*/
|
|
19140
|
+
price: {
|
|
19141
|
+
/** @description Amount excluding tax in major units. */
|
|
19142
|
+
netAmount: number;
|
|
19143
|
+
/** @description Tax amount in major units. */
|
|
19144
|
+
taxAmount?: number;
|
|
19145
|
+
};
|
|
19146
|
+
};
|
|
19147
|
+
/** @description ISO currency code. */
|
|
19148
|
+
currencyCode: string;
|
|
19149
|
+
/** @description Customer associated with this transaction. */
|
|
19150
|
+
customer?: {
|
|
19151
|
+
/**
|
|
19152
|
+
* Format: uuid
|
|
19153
|
+
* @description ID of the company or user.
|
|
19154
|
+
*/
|
|
19155
|
+
id: string;
|
|
19156
|
+
/** @description Company logo. */
|
|
19157
|
+
logo?: {
|
|
19158
|
+
key: string;
|
|
19159
|
+
url: string;
|
|
19160
|
+
};
|
|
19161
|
+
/** @description Public logo URL derived from the company website. */
|
|
19162
|
+
publicLogoUrl?: string;
|
|
19163
|
+
/** @description Company name. */
|
|
19164
|
+
title?: string;
|
|
19165
|
+
/**
|
|
19166
|
+
* @description Whether the customer is a company or a user.
|
|
19167
|
+
* @enum {string}
|
|
19168
|
+
*/
|
|
19169
|
+
type: "company" | "user";
|
|
19170
|
+
/** @description User details for user customers. */
|
|
19171
|
+
user?: {
|
|
19172
|
+
about?: string | null;
|
|
19173
|
+
email?: string | null;
|
|
19174
|
+
/** Format: uuid */
|
|
19175
|
+
id: string;
|
|
19176
|
+
name?: string | null;
|
|
19177
|
+
phoneNumber?: string | null;
|
|
19178
|
+
photoUrl?: string | null;
|
|
19179
|
+
surname?: string | null;
|
|
19180
|
+
};
|
|
19181
|
+
};
|
|
19182
|
+
/**
|
|
19183
|
+
* Format: uuid
|
|
19184
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
19185
|
+
*/
|
|
19186
|
+
customerRefCreatedBy?: string;
|
|
19187
|
+
/** @description Customer billing address. */
|
|
19188
|
+
customerAddress?: {
|
|
19189
|
+
city: string;
|
|
19190
|
+
countryCode: string | null;
|
|
19191
|
+
line1: string;
|
|
19192
|
+
line2: string;
|
|
19193
|
+
postalCode: string;
|
|
19194
|
+
state: string;
|
|
19195
|
+
};
|
|
19196
|
+
/** @description Customer legal name. */
|
|
19197
|
+
customerName?: string;
|
|
19198
|
+
/** @description Customer tax ID. */
|
|
19199
|
+
customerTaxId?: string;
|
|
19200
|
+
/** @description Custom item details. */
|
|
19201
|
+
customItem?: {
|
|
19202
|
+
/** @description Custom item currency code. */
|
|
19203
|
+
currencyCode?: string;
|
|
19204
|
+
/** @description Custom item description. */
|
|
19205
|
+
description?: string;
|
|
19206
|
+
tax?: {
|
|
19207
|
+
/** @description Whether tax is enabled for the custom item. */
|
|
19208
|
+
enabled: boolean;
|
|
19209
|
+
/** @description Tax rate. */
|
|
19210
|
+
rate: number;
|
|
19211
|
+
};
|
|
19212
|
+
/** @description Custom item unit amount in major units. */
|
|
19213
|
+
unitAmount?: number;
|
|
19214
|
+
/** @description Custom item unit quantity. */
|
|
19215
|
+
unitQuantity?: number;
|
|
19216
|
+
};
|
|
19217
|
+
/** @description Discounts applied to the transaction. */
|
|
19218
|
+
discounts?: {
|
|
19219
|
+
/** @description Applied coupon. */
|
|
19220
|
+
coupon: {
|
|
19221
|
+
/** @description Fixed amount discount. */
|
|
19222
|
+
amountOff?: number;
|
|
19223
|
+
/** @description Currency of the fixed amount discount. */
|
|
19224
|
+
currencyCode?: string;
|
|
19225
|
+
/** @description Coupon id. */
|
|
19226
|
+
id?: string;
|
|
19227
|
+
/** @description Percentage discount. */
|
|
19228
|
+
percentOff?: number;
|
|
19229
|
+
/** @description Product types the coupon applies to. */
|
|
19230
|
+
productTypes?: string[];
|
|
19231
|
+
/** @description Coupon type. */
|
|
19232
|
+
type?: string;
|
|
19233
|
+
};
|
|
19234
|
+
/** @description Promocode the coupon was applied with. */
|
|
19235
|
+
promocode?: {
|
|
19236
|
+
/** @description Promocode. */
|
|
19237
|
+
code: string;
|
|
19238
|
+
/** @description Promocode expiration settings. */
|
|
19239
|
+
expiration?: {
|
|
19240
|
+
/**
|
|
19241
|
+
* Format: date-time
|
|
19242
|
+
* @description ISO timestamp when the promocode expires.
|
|
19243
|
+
*/
|
|
19244
|
+
date?: string;
|
|
19245
|
+
/** @description Whether the promocode has an expiration date. */
|
|
19246
|
+
enabled: boolean;
|
|
19247
|
+
};
|
|
19248
|
+
/**
|
|
19249
|
+
* Format: uuid
|
|
19250
|
+
* @description Promocode id.
|
|
19251
|
+
*/
|
|
19252
|
+
id: string;
|
|
19253
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
19254
|
+
limitByFirstPurchase?: boolean;
|
|
19255
|
+
};
|
|
19256
|
+
/**
|
|
19257
|
+
* Format: uuid
|
|
19258
|
+
* @description ID of the subscription this discount is associated with.
|
|
19259
|
+
*/
|
|
19260
|
+
subscriptionId?: string;
|
|
19261
|
+
}[];
|
|
19262
|
+
/** @description Payment gateway error description for failed transactions. */
|
|
19263
|
+
errorDescription?: string;
|
|
19264
|
+
/**
|
|
19265
|
+
* Format: uuid
|
|
19266
|
+
* @description Unique identifier of the transaction.
|
|
19267
|
+
*/
|
|
19268
|
+
id: string;
|
|
19269
|
+
/**
|
|
19270
|
+
* @deprecated
|
|
19271
|
+
* @description Deprecated. Use product instead.
|
|
19272
|
+
*/
|
|
19273
|
+
invoice?: {
|
|
19274
|
+
/**
|
|
19275
|
+
* Format: uuid
|
|
19276
|
+
* @description Invoice id.
|
|
19277
|
+
*/
|
|
19278
|
+
id: string;
|
|
19279
|
+
/** @description Invoice title. */
|
|
19280
|
+
title: string;
|
|
19281
|
+
};
|
|
19282
|
+
/** @description Location billing address. */
|
|
19283
|
+
locationAddress?: {
|
|
19284
|
+
city: string;
|
|
19285
|
+
countryCode: string | null;
|
|
19286
|
+
line1: string;
|
|
19287
|
+
line2: string;
|
|
19288
|
+
postalCode: string;
|
|
19289
|
+
state: string;
|
|
19290
|
+
};
|
|
19291
|
+
/** @description Location legal name. */
|
|
19292
|
+
locationName?: string;
|
|
19293
|
+
/**
|
|
19294
|
+
* Format: uuid
|
|
19295
|
+
* @description ID of the organization (location).
|
|
19296
|
+
*/
|
|
19297
|
+
locationRef: string;
|
|
19298
|
+
/** @description Location tax ID. */
|
|
19299
|
+
locationTaxId?: string;
|
|
19300
|
+
/**
|
|
19301
|
+
* Format: uuid
|
|
19302
|
+
* @deprecated
|
|
19303
|
+
* @description Deprecated. Use customer instead.
|
|
19304
|
+
*/
|
|
19305
|
+
membershipRef?: string;
|
|
19306
|
+
/**
|
|
19307
|
+
* Format: uuid
|
|
19308
|
+
* @deprecated
|
|
19309
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
19310
|
+
*/
|
|
19311
|
+
membershipRefCreator?: string;
|
|
19312
|
+
/**
|
|
19313
|
+
* Format: uuid
|
|
19314
|
+
* @description ID of the network.
|
|
19315
|
+
*/
|
|
19316
|
+
networkRef: string;
|
|
19317
|
+
/**
|
|
19318
|
+
* @deprecated
|
|
19319
|
+
* @description Deprecated. Use product instead.
|
|
19320
|
+
*/
|
|
19321
|
+
order?: {
|
|
19322
|
+
/**
|
|
19323
|
+
* Format: uuid
|
|
19324
|
+
* @description Order id.
|
|
19325
|
+
*/
|
|
19326
|
+
id: string;
|
|
19327
|
+
/** @description Order items. */
|
|
19328
|
+
items: {
|
|
19329
|
+
/**
|
|
19330
|
+
* Format: uuid
|
|
19331
|
+
* @description Order item id.
|
|
19332
|
+
*/
|
|
19333
|
+
id: string;
|
|
19334
|
+
/** @description Ordered product. */
|
|
19335
|
+
product: {
|
|
19336
|
+
/**
|
|
19337
|
+
* Format: uuid
|
|
19338
|
+
* @description Product id.
|
|
19339
|
+
*/
|
|
19340
|
+
id: string;
|
|
19341
|
+
/** @description Product option. */
|
|
19342
|
+
option?: {
|
|
19343
|
+
/**
|
|
19344
|
+
* Format: uuid
|
|
19345
|
+
* @description Product option id.
|
|
19346
|
+
*/
|
|
19347
|
+
id: string;
|
|
19348
|
+
/** @description Product option title. */
|
|
19349
|
+
title: string;
|
|
19350
|
+
};
|
|
19351
|
+
/** @description Product title. */
|
|
19352
|
+
title: string;
|
|
19353
|
+
};
|
|
19354
|
+
/** @description Quantity of units. */
|
|
19355
|
+
quantity: number;
|
|
19356
|
+
}[];
|
|
19357
|
+
};
|
|
19358
|
+
/** @description Payment details. */
|
|
19359
|
+
payment: {
|
|
19360
|
+
/** @description Payment dispute details. */
|
|
19361
|
+
dispute?: {
|
|
19362
|
+
/**
|
|
19363
|
+
* Format: date-time
|
|
19364
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
19365
|
+
*/
|
|
19366
|
+
createDate: string;
|
|
19367
|
+
};
|
|
19368
|
+
/** @description Payment method used. */
|
|
19369
|
+
method: {
|
|
19370
|
+
/** @description Present when type is external. */
|
|
19371
|
+
external?: Record<string, never>;
|
|
19372
|
+
/** @description Present when type is paymentGateway. */
|
|
19373
|
+
paymentGateway?: {
|
|
19374
|
+
/** @description Payment gateway identifier. */
|
|
19375
|
+
gateway: string;
|
|
19376
|
+
/** @description Display label for the payment method. */
|
|
19377
|
+
label?: string;
|
|
19378
|
+
/** @description Masked card or account identifier. */
|
|
19379
|
+
mask?: string;
|
|
19380
|
+
/** @description Display title for the payment gateway. */
|
|
19381
|
+
title?: string;
|
|
19382
|
+
};
|
|
19383
|
+
/**
|
|
19384
|
+
* @description Payment method type.
|
|
19385
|
+
* @enum {string}
|
|
19386
|
+
*/
|
|
19387
|
+
type: "external" | "paymentGateway";
|
|
19388
|
+
};
|
|
19389
|
+
/** @description Payment price details. */
|
|
19390
|
+
price: {
|
|
19391
|
+
money: {
|
|
19392
|
+
/** @description ISO currency code. */
|
|
19393
|
+
currencyCode: string;
|
|
19394
|
+
/** @description Payment amount in major units. */
|
|
19395
|
+
grossAmount: number;
|
|
19396
|
+
};
|
|
19397
|
+
/** @enum {string} */
|
|
19398
|
+
type: "money";
|
|
19399
|
+
};
|
|
19400
|
+
/** @description Whether this payment can be refunded. */
|
|
19401
|
+
refundable: boolean;
|
|
19402
|
+
/** @description Refunds issued against this payment. */
|
|
19403
|
+
refunds?: {
|
|
19404
|
+
money: {
|
|
19405
|
+
/**
|
|
19406
|
+
* Format: date-time
|
|
19407
|
+
* @description Refund creation timestamp.
|
|
19408
|
+
*/
|
|
19409
|
+
createDate: string;
|
|
19410
|
+
/** @description ISO currency code. */
|
|
19411
|
+
currencyCode: string;
|
|
19412
|
+
/**
|
|
19413
|
+
* Format: uuid
|
|
19414
|
+
* @description ID of the customer the user who created the refund belongs to.
|
|
19415
|
+
*/
|
|
19416
|
+
customerRefCreatedBy?: string;
|
|
19417
|
+
/** @description Refunded amount in major units. */
|
|
19418
|
+
grossAmount: number;
|
|
19419
|
+
/**
|
|
19420
|
+
* Format: uuid
|
|
19421
|
+
* @description Refund id.
|
|
19422
|
+
*/
|
|
19423
|
+
id: string;
|
|
19424
|
+
/** @description Who initiated the refund: `spacebring` for a refund issued in Spacebring, `stripe` for one issued in the Stripe dashboard. */
|
|
19425
|
+
initiator?: string;
|
|
19426
|
+
/** @description User who created the refund. */
|
|
19427
|
+
userCreatedBy?: {
|
|
19428
|
+
about?: string | null;
|
|
19429
|
+
email?: string | null;
|
|
19430
|
+
/** Format: uuid */
|
|
19431
|
+
id: string;
|
|
19432
|
+
name?: string | null;
|
|
19433
|
+
phoneNumber?: string | null;
|
|
19434
|
+
photoUrl?: string | null;
|
|
19435
|
+
surname?: string | null;
|
|
19436
|
+
};
|
|
19437
|
+
}[];
|
|
19438
|
+
/** @enum {string} */
|
|
19439
|
+
type: "money";
|
|
19440
|
+
};
|
|
19441
|
+
/** @description Payment surcharge details. */
|
|
19442
|
+
surcharge?: {
|
|
19443
|
+
money: {
|
|
19444
|
+
/** @description Surcharge amount in major units. */
|
|
19445
|
+
amount: number;
|
|
19446
|
+
/** @description ISO currency code. */
|
|
19447
|
+
currencyCode: string;
|
|
19448
|
+
/** @description Surcharge percentage. */
|
|
19449
|
+
percentage?: number;
|
|
19450
|
+
/** @description Surcharge rate. */
|
|
19451
|
+
rate?: number;
|
|
19452
|
+
};
|
|
19453
|
+
/** @enum {string} */
|
|
19454
|
+
type: "money";
|
|
19455
|
+
};
|
|
19456
|
+
};
|
|
19457
|
+
/**
|
|
19458
|
+
* @deprecated
|
|
19459
|
+
* @description Deprecated. Use payment.method instead.
|
|
19460
|
+
*/
|
|
19461
|
+
paymentMethod: {
|
|
19462
|
+
/** @description Display label of the payment method. */
|
|
19463
|
+
label?: string;
|
|
19464
|
+
/** @description Payment gateway identifier, or external. */
|
|
19465
|
+
type: string;
|
|
19466
|
+
};
|
|
19467
|
+
/**
|
|
19468
|
+
* @deprecated
|
|
19469
|
+
* @description Deprecated. Use product instead.
|
|
19470
|
+
*/
|
|
19471
|
+
plan?: {
|
|
19472
|
+
/**
|
|
19473
|
+
* Format: uuid
|
|
19474
|
+
* @description Plan id.
|
|
19475
|
+
*/
|
|
19476
|
+
id: string;
|
|
19477
|
+
/** @description Plan title. */
|
|
19478
|
+
title: string;
|
|
19479
|
+
};
|
|
19480
|
+
/** @description Product details. */
|
|
19481
|
+
product?: {
|
|
19482
|
+
/**
|
|
19483
|
+
* Format: uuid
|
|
19484
|
+
* @description ID of the associated booking.
|
|
19485
|
+
*/
|
|
19486
|
+
bookingRef?: string;
|
|
19487
|
+
/**
|
|
19488
|
+
* Format: uuid
|
|
19489
|
+
* @description ID of the associated event ticket.
|
|
19490
|
+
*/
|
|
19491
|
+
eventTicketRef?: string;
|
|
19492
|
+
/**
|
|
19493
|
+
* Format: uuid
|
|
19494
|
+
* @description ID of the associated invoice.
|
|
19495
|
+
*/
|
|
19496
|
+
invoiceRef?: string;
|
|
19497
|
+
/**
|
|
19498
|
+
* Format: uuid
|
|
19499
|
+
* @description ID of the associated order.
|
|
19500
|
+
*/
|
|
19501
|
+
orderRef?: string;
|
|
19502
|
+
/**
|
|
19503
|
+
* Format: uuid
|
|
19504
|
+
* @description ID of the associated subscription.
|
|
19505
|
+
*/
|
|
19506
|
+
subscriptionRef?: string;
|
|
19507
|
+
/** @description Display title of the product. */
|
|
19508
|
+
title?: string;
|
|
19509
|
+
/**
|
|
19510
|
+
* @description Product type.
|
|
19511
|
+
* @enum {string}
|
|
19512
|
+
*/
|
|
19513
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
19514
|
+
};
|
|
19515
|
+
/** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
|
|
19516
|
+
receiptPdfUrl?: string;
|
|
19517
|
+
/**
|
|
19518
|
+
* @deprecated
|
|
19519
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
19520
|
+
*/
|
|
19521
|
+
refund?: {
|
|
19522
|
+
/** @description Refunded amount. */
|
|
19523
|
+
amount: number;
|
|
19524
|
+
/**
|
|
19525
|
+
* Format: date-time
|
|
19526
|
+
* @description Refund creation timestamp.
|
|
19527
|
+
*/
|
|
19528
|
+
createDate: string;
|
|
19529
|
+
};
|
|
19530
|
+
/**
|
|
19531
|
+
* @deprecated
|
|
19532
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
19533
|
+
*/
|
|
19534
|
+
refunds?: {
|
|
19535
|
+
/** @description Refunded amount. */
|
|
19536
|
+
amount: number;
|
|
19537
|
+
/**
|
|
19538
|
+
* Format: date-time
|
|
19539
|
+
* @description Refund creation timestamp.
|
|
19540
|
+
*/
|
|
19541
|
+
createDate: string;
|
|
19542
|
+
/** @description ISO currency code. */
|
|
19543
|
+
currencyCode?: string;
|
|
19544
|
+
/**
|
|
19545
|
+
* Format: uuid
|
|
19546
|
+
* @description Refund id.
|
|
19547
|
+
*/
|
|
18273
19548
|
id?: string;
|
|
18274
|
-
|
|
19549
|
+
/** @description Refund initiator. */
|
|
19550
|
+
initiator?: string;
|
|
19551
|
+
/**
|
|
19552
|
+
* Format: uuid
|
|
19553
|
+
* @description Membership of the user who created the refund.
|
|
19554
|
+
*/
|
|
19555
|
+
membershipRefCreator?: string;
|
|
19556
|
+
/**
|
|
19557
|
+
* Format: uuid
|
|
19558
|
+
* @description Location id.
|
|
19559
|
+
*/
|
|
19560
|
+
organizationRef: string;
|
|
19561
|
+
/** @description User who created the refund. */
|
|
19562
|
+
userCreator?: {
|
|
19563
|
+
about?: string | null;
|
|
19564
|
+
email?: string | null;
|
|
19565
|
+
/** Format: uuid */
|
|
19566
|
+
id: string;
|
|
19567
|
+
name?: string | null;
|
|
19568
|
+
phoneNumber?: string | null;
|
|
19569
|
+
photoUrl?: string | null;
|
|
19570
|
+
surname?: string | null;
|
|
19571
|
+
};
|
|
19572
|
+
/**
|
|
19573
|
+
* Format: uuid
|
|
19574
|
+
* @description User id of the refund creator.
|
|
19575
|
+
*/
|
|
19576
|
+
userRefCreator?: string;
|
|
19577
|
+
}[];
|
|
19578
|
+
/**
|
|
19579
|
+
* @description Transaction status.
|
|
19580
|
+
* @enum {string}
|
|
19581
|
+
*/
|
|
19582
|
+
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
|
|
19583
|
+
/**
|
|
19584
|
+
* @deprecated
|
|
19585
|
+
* @description Deprecated. Use product instead.
|
|
19586
|
+
*/
|
|
19587
|
+
ticket?: {
|
|
19588
|
+
/**
|
|
19589
|
+
* Format: date-time
|
|
19590
|
+
* @description Ticket creation timestamp.
|
|
19591
|
+
*/
|
|
19592
|
+
createDate?: string;
|
|
19593
|
+
/**
|
|
19594
|
+
* Format: date-time
|
|
19595
|
+
* @description ISO timestamp of when the ticket was deleted.
|
|
19596
|
+
*/
|
|
19597
|
+
deleteDate?: string;
|
|
19598
|
+
/** @description Event details. */
|
|
19599
|
+
event?: {
|
|
19600
|
+
/**
|
|
19601
|
+
* Format: date-time
|
|
19602
|
+
* @description Event end date.
|
|
19603
|
+
*/
|
|
19604
|
+
endDate?: string;
|
|
19605
|
+
/**
|
|
19606
|
+
* Format: uuid
|
|
19607
|
+
* @description Event id.
|
|
19608
|
+
*/
|
|
19609
|
+
id: string;
|
|
19610
|
+
/**
|
|
19611
|
+
* Format: date-time
|
|
19612
|
+
* @description Event start date.
|
|
19613
|
+
*/
|
|
19614
|
+
startDate?: string;
|
|
19615
|
+
/** @description Event title. */
|
|
19616
|
+
title: string;
|
|
19617
|
+
};
|
|
19618
|
+
/**
|
|
19619
|
+
* Format: uuid
|
|
19620
|
+
* @description Ticket id.
|
|
19621
|
+
*/
|
|
19622
|
+
id: string;
|
|
19623
|
+
/**
|
|
19624
|
+
* Format: uuid
|
|
19625
|
+
* @description Membership of the user who deleted the ticket.
|
|
19626
|
+
*/
|
|
19627
|
+
membershipRefDeletedBy?: string;
|
|
19628
|
+
/**
|
|
19629
|
+
* @deprecated
|
|
19630
|
+
* @description Ticket price.
|
|
19631
|
+
*/
|
|
19632
|
+
price: {
|
|
19633
|
+
/** @description Amount excluding tax in major units. */
|
|
19634
|
+
netAmount: number;
|
|
19635
|
+
/** @description Tax amount in major units. */
|
|
19636
|
+
taxAmount?: number;
|
|
19637
|
+
};
|
|
19638
|
+
/** @description Number of tickets. */
|
|
19639
|
+
quantity: number;
|
|
19640
|
+
/** @description User who deleted the ticket. */
|
|
19641
|
+
userDeletedBy?: {
|
|
19642
|
+
about?: string | null;
|
|
19643
|
+
email?: string | null;
|
|
19644
|
+
/** Format: uuid */
|
|
19645
|
+
id: string;
|
|
19646
|
+
name?: string | null;
|
|
19647
|
+
phoneNumber?: string | null;
|
|
19648
|
+
photoUrl?: string | null;
|
|
19649
|
+
surname?: string | null;
|
|
19650
|
+
};
|
|
19651
|
+
};
|
|
19652
|
+
/**
|
|
19653
|
+
* @description Money transaction type.
|
|
19654
|
+
* @enum {string}
|
|
19655
|
+
*/
|
|
19656
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
19657
|
+
/**
|
|
19658
|
+
* @deprecated
|
|
19659
|
+
* @description Deprecated. Use customer.user instead.
|
|
19660
|
+
*/
|
|
19661
|
+
user?: {
|
|
19662
|
+
about?: string | null;
|
|
19663
|
+
email?: string | null;
|
|
19664
|
+
/** Format: uuid */
|
|
19665
|
+
id: string;
|
|
19666
|
+
name?: string | null;
|
|
19667
|
+
phoneNumber?: string | null;
|
|
19668
|
+
photoUrl?: string | null;
|
|
19669
|
+
surname?: string | null;
|
|
19670
|
+
};
|
|
19671
|
+
/** @description User who created the transaction. */
|
|
19672
|
+
userCreatedBy?: {
|
|
19673
|
+
about?: string | null;
|
|
19674
|
+
email?: string | null;
|
|
19675
|
+
/** Format: uuid */
|
|
19676
|
+
id: string;
|
|
19677
|
+
name?: string | null;
|
|
19678
|
+
phoneNumber?: string | null;
|
|
19679
|
+
photoUrl?: string | null;
|
|
19680
|
+
surname?: string | null;
|
|
19681
|
+
};
|
|
19682
|
+
/**
|
|
19683
|
+
* @deprecated
|
|
19684
|
+
* @description Deprecated. Use customer.user instead.
|
|
19685
|
+
*/
|
|
19686
|
+
userOwner?: {
|
|
19687
|
+
about?: string | null;
|
|
19688
|
+
email?: string | null;
|
|
19689
|
+
/** Format: uuid */
|
|
19690
|
+
id: string;
|
|
19691
|
+
name?: string | null;
|
|
19692
|
+
phoneNumber?: string | null;
|
|
19693
|
+
photoUrl?: string | null;
|
|
19694
|
+
surname?: string | null;
|
|
19695
|
+
};
|
|
19696
|
+
/**
|
|
19697
|
+
* Format: uuid
|
|
19698
|
+
* @deprecated
|
|
19699
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
19700
|
+
*/
|
|
19701
|
+
userRefCreator?: string;
|
|
19702
|
+
/**
|
|
19703
|
+
* Format: uuid
|
|
19704
|
+
* @deprecated
|
|
19705
|
+
* @description Deprecated. Use customer.user instead.
|
|
19706
|
+
*/
|
|
19707
|
+
userRefOwner?: string;
|
|
19708
|
+
};
|
|
19709
|
+
};
|
|
19710
|
+
getMoneyTransaction: {
|
|
19711
|
+
/** @description The money transaction. */
|
|
19712
|
+
transaction: {
|
|
19713
|
+
/** @description Transaction amount in major units. */
|
|
19714
|
+
amount: number;
|
|
19715
|
+
/**
|
|
19716
|
+
* @deprecated
|
|
19717
|
+
* @description Deprecated. Use locationAddress instead.
|
|
19718
|
+
*/
|
|
19719
|
+
billingAddressBy?: string;
|
|
19720
|
+
/**
|
|
19721
|
+
* @deprecated
|
|
19722
|
+
* @description Deprecated. Use customerAddress instead.
|
|
19723
|
+
*/
|
|
19724
|
+
billingAddressTo?: string;
|
|
19725
|
+
/**
|
|
19726
|
+
* @deprecated
|
|
19727
|
+
* @description Deprecated. Use product instead.
|
|
19728
|
+
*/
|
|
19729
|
+
booking?: {
|
|
19730
|
+
/**
|
|
19731
|
+
* Format: date-time
|
|
19732
|
+
* @description ISO timestamp of when the booking was deleted.
|
|
19733
|
+
*/
|
|
19734
|
+
deleteDate?: string;
|
|
19735
|
+
/**
|
|
19736
|
+
* Format: date-time
|
|
19737
|
+
* @description Booking end date.
|
|
19738
|
+
*/
|
|
19739
|
+
endDate?: string;
|
|
19740
|
+
/**
|
|
19741
|
+
* Format: uuid
|
|
19742
|
+
* @description Booking id.
|
|
19743
|
+
*/
|
|
19744
|
+
id: string;
|
|
19745
|
+
/**
|
|
19746
|
+
* Format: uuid
|
|
19747
|
+
* @description Membership of the user who deleted the booking.
|
|
19748
|
+
*/
|
|
19749
|
+
membershipRefDeletedBy?: string;
|
|
19750
|
+
/**
|
|
19751
|
+
* @deprecated
|
|
19752
|
+
* @description Booking price.
|
|
19753
|
+
*/
|
|
19754
|
+
price: {
|
|
19755
|
+
/** @description Amount excluding tax in major units. */
|
|
19756
|
+
netAmount: number;
|
|
19757
|
+
/** @description Tax amount in major units. */
|
|
19758
|
+
taxAmount?: number;
|
|
19759
|
+
};
|
|
19760
|
+
/** @description Booked resource. */
|
|
19761
|
+
resource: {
|
|
19762
|
+
/**
|
|
19763
|
+
* Format: uuid
|
|
19764
|
+
* @description Resource id.
|
|
19765
|
+
*/
|
|
19766
|
+
id: string;
|
|
19767
|
+
/** @description Resource title. */
|
|
19768
|
+
title: string;
|
|
19769
|
+
};
|
|
19770
|
+
/**
|
|
19771
|
+
* Format: date-time
|
|
19772
|
+
* @description Booking start date.
|
|
19773
|
+
*/
|
|
19774
|
+
startDate?: string;
|
|
19775
|
+
/** @description User who deleted the booking. */
|
|
19776
|
+
userDeletedBy?: {
|
|
19777
|
+
about?: string | null;
|
|
19778
|
+
email?: string | null;
|
|
19779
|
+
/** Format: uuid */
|
|
19780
|
+
id: string;
|
|
19781
|
+
name?: string | null;
|
|
19782
|
+
phoneNumber?: string | null;
|
|
19783
|
+
photoUrl?: string | null;
|
|
19784
|
+
surname?: string | null;
|
|
19785
|
+
};
|
|
19786
|
+
};
|
|
19787
|
+
/**
|
|
19788
|
+
* @deprecated
|
|
19789
|
+
* @description Deprecated. Use customer instead.
|
|
19790
|
+
*/
|
|
19791
|
+
company?: {
|
|
19792
|
+
/**
|
|
19793
|
+
* Format: date-time
|
|
19794
|
+
* @description ISO timestamp of company creation.
|
|
19795
|
+
*/
|
|
19796
|
+
createDate: string;
|
|
19797
|
+
/**
|
|
19798
|
+
* Format: uuid
|
|
19799
|
+
* @description Company id.
|
|
19800
|
+
*/
|
|
19801
|
+
id: string;
|
|
19802
|
+
/**
|
|
19803
|
+
* Format: uuid
|
|
19804
|
+
* @description Location id.
|
|
19805
|
+
*/
|
|
19806
|
+
locationRef: string;
|
|
19807
|
+
/** @description Company metadata. */
|
|
19808
|
+
metadata?: {
|
|
19809
|
+
[key: string]: unknown;
|
|
19810
|
+
};
|
|
19811
|
+
/** @description Internal notes. */
|
|
19812
|
+
notes?: string;
|
|
19813
|
+
/**
|
|
19814
|
+
* Format: uuid
|
|
19815
|
+
* @description Primary subscription id.
|
|
19816
|
+
*/
|
|
19817
|
+
subscriptionRef: string | null;
|
|
19818
|
+
/** @description Company name. */
|
|
19819
|
+
title: string;
|
|
19820
|
+
};
|
|
19821
|
+
/**
|
|
19822
|
+
* Format: uuid
|
|
19823
|
+
* @deprecated
|
|
19824
|
+
* @description Deprecated. Use customer instead.
|
|
19825
|
+
*/
|
|
19826
|
+
companyRef?: string;
|
|
19827
|
+
/**
|
|
19828
|
+
* Format: date-time
|
|
19829
|
+
* @description ISO timestamp of when the transaction was created.
|
|
19830
|
+
*/
|
|
19831
|
+
createDate: string;
|
|
19832
|
+
/**
|
|
19833
|
+
* @deprecated
|
|
19834
|
+
* @description Deprecated. Use product instead.
|
|
19835
|
+
*/
|
|
19836
|
+
creditPackage?: {
|
|
19837
|
+
/** @description Credits amount of the package, or the package price when the package has no credits. */
|
|
19838
|
+
amount: number;
|
|
19839
|
+
/** @description Credits amount of the package. */
|
|
19840
|
+
creditsAmount?: number;
|
|
19841
|
+
/** @description Day passes amount of the package. */
|
|
19842
|
+
dayPassesAmount?: number;
|
|
19843
|
+
/**
|
|
19844
|
+
* @deprecated
|
|
19845
|
+
* @description Package price.
|
|
19846
|
+
*/
|
|
19847
|
+
price: {
|
|
19848
|
+
/** @description Amount excluding tax in major units. */
|
|
19849
|
+
netAmount: number;
|
|
19850
|
+
/** @description Tax amount in major units. */
|
|
19851
|
+
taxAmount?: number;
|
|
19852
|
+
};
|
|
19853
|
+
};
|
|
19854
|
+
/** @description ISO currency code. */
|
|
19855
|
+
currencyCode: string;
|
|
19856
|
+
/** @description Customer associated with this transaction. */
|
|
19857
|
+
customer?: {
|
|
19858
|
+
/**
|
|
19859
|
+
* Format: uuid
|
|
19860
|
+
* @description ID of the company or user.
|
|
19861
|
+
*/
|
|
19862
|
+
id: string;
|
|
19863
|
+
/** @description Company logo. */
|
|
19864
|
+
logo?: {
|
|
19865
|
+
key: string;
|
|
19866
|
+
url: string;
|
|
19867
|
+
};
|
|
19868
|
+
/** @description Public logo URL derived from the company website. */
|
|
19869
|
+
publicLogoUrl?: string;
|
|
19870
|
+
/** @description Company name. */
|
|
19871
|
+
title?: string;
|
|
19872
|
+
/**
|
|
19873
|
+
* @description Whether the customer is a company or a user.
|
|
19874
|
+
* @enum {string}
|
|
19875
|
+
*/
|
|
19876
|
+
type: "company" | "user";
|
|
19877
|
+
/** @description User details for user customers. */
|
|
19878
|
+
user?: {
|
|
19879
|
+
about?: string | null;
|
|
19880
|
+
email?: string | null;
|
|
19881
|
+
/** Format: uuid */
|
|
19882
|
+
id: string;
|
|
19883
|
+
name?: string | null;
|
|
19884
|
+
phoneNumber?: string | null;
|
|
19885
|
+
photoUrl?: string | null;
|
|
19886
|
+
surname?: string | null;
|
|
19887
|
+
};
|
|
19888
|
+
};
|
|
19889
|
+
/**
|
|
19890
|
+
* Format: uuid
|
|
19891
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
19892
|
+
*/
|
|
19893
|
+
customerRefCreatedBy?: string;
|
|
19894
|
+
/** @description Customer billing address. */
|
|
19895
|
+
customerAddress?: {
|
|
19896
|
+
city: string;
|
|
19897
|
+
countryCode: string | null;
|
|
19898
|
+
line1: string;
|
|
19899
|
+
line2: string;
|
|
19900
|
+
postalCode: string;
|
|
19901
|
+
state: string;
|
|
19902
|
+
};
|
|
19903
|
+
/** @description Customer legal name. */
|
|
19904
|
+
customerName?: string;
|
|
19905
|
+
/** @description Customer tax ID. */
|
|
19906
|
+
customerTaxId?: string;
|
|
19907
|
+
/** @description Custom item details. */
|
|
19908
|
+
customItem?: {
|
|
19909
|
+
/** @description Custom item currency code. */
|
|
19910
|
+
currencyCode?: string;
|
|
19911
|
+
/** @description Custom item description. */
|
|
19912
|
+
description?: string;
|
|
19913
|
+
tax?: {
|
|
19914
|
+
/** @description Whether tax is enabled for the custom item. */
|
|
19915
|
+
enabled: boolean;
|
|
19916
|
+
/** @description Tax rate. */
|
|
19917
|
+
rate: number;
|
|
19918
|
+
};
|
|
19919
|
+
/** @description Custom item unit amount in major units. */
|
|
19920
|
+
unitAmount?: number;
|
|
19921
|
+
/** @description Custom item unit quantity. */
|
|
19922
|
+
unitQuantity?: number;
|
|
19923
|
+
};
|
|
19924
|
+
/** @description Discounts applied to the transaction. */
|
|
19925
|
+
discounts?: {
|
|
19926
|
+
/** @description Applied coupon. */
|
|
19927
|
+
coupon: {
|
|
19928
|
+
/** @description Fixed amount discount. */
|
|
19929
|
+
amountOff?: number;
|
|
19930
|
+
/** @description Currency of the fixed amount discount. */
|
|
19931
|
+
currencyCode?: string;
|
|
19932
|
+
/** @description Coupon id. */
|
|
19933
|
+
id?: string;
|
|
19934
|
+
/** @description Percentage discount. */
|
|
19935
|
+
percentOff?: number;
|
|
19936
|
+
/** @description Product types the coupon applies to. */
|
|
19937
|
+
productTypes?: string[];
|
|
19938
|
+
/** @description Coupon type. */
|
|
19939
|
+
type?: string;
|
|
19940
|
+
};
|
|
19941
|
+
/** @description Promocode the coupon was applied with. */
|
|
19942
|
+
promocode?: {
|
|
19943
|
+
/** @description Promocode. */
|
|
19944
|
+
code: string;
|
|
19945
|
+
/** @description Promocode expiration settings. */
|
|
19946
|
+
expiration?: {
|
|
19947
|
+
/**
|
|
19948
|
+
* Format: date-time
|
|
19949
|
+
* @description ISO timestamp when the promocode expires.
|
|
19950
|
+
*/
|
|
19951
|
+
date?: string;
|
|
19952
|
+
/** @description Whether the promocode has an expiration date. */
|
|
19953
|
+
enabled: boolean;
|
|
19954
|
+
};
|
|
19955
|
+
/**
|
|
19956
|
+
* Format: uuid
|
|
19957
|
+
* @description Promocode id.
|
|
19958
|
+
*/
|
|
19959
|
+
id: string;
|
|
19960
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
19961
|
+
limitByFirstPurchase?: boolean;
|
|
19962
|
+
};
|
|
19963
|
+
/**
|
|
19964
|
+
* Format: uuid
|
|
19965
|
+
* @description ID of the subscription this discount is associated with.
|
|
19966
|
+
*/
|
|
19967
|
+
subscriptionId?: string;
|
|
19968
|
+
}[];
|
|
19969
|
+
/** @description Payment gateway error description for failed transactions. */
|
|
19970
|
+
errorDescription?: string;
|
|
19971
|
+
/**
|
|
19972
|
+
* Format: uuid
|
|
19973
|
+
* @description Unique identifier of the transaction.
|
|
19974
|
+
*/
|
|
19975
|
+
id: string;
|
|
19976
|
+
/**
|
|
19977
|
+
* @deprecated
|
|
19978
|
+
* @description Deprecated. Use product instead.
|
|
19979
|
+
*/
|
|
19980
|
+
invoice?: {
|
|
19981
|
+
/**
|
|
19982
|
+
* Format: uuid
|
|
19983
|
+
* @description Invoice id.
|
|
19984
|
+
*/
|
|
19985
|
+
id: string;
|
|
19986
|
+
/** @description Invoice title. */
|
|
19987
|
+
title: string;
|
|
19988
|
+
};
|
|
19989
|
+
/** @description Location billing address. */
|
|
19990
|
+
locationAddress?: {
|
|
19991
|
+
city: string;
|
|
19992
|
+
countryCode: string | null;
|
|
19993
|
+
line1: string;
|
|
19994
|
+
line2: string;
|
|
19995
|
+
postalCode: string;
|
|
19996
|
+
state: string;
|
|
19997
|
+
};
|
|
19998
|
+
/** @description Location legal name. */
|
|
19999
|
+
locationName?: string;
|
|
20000
|
+
/**
|
|
20001
|
+
* Format: uuid
|
|
20002
|
+
* @description ID of the organization (location).
|
|
20003
|
+
*/
|
|
20004
|
+
locationRef: string;
|
|
20005
|
+
/** @description Location tax ID. */
|
|
20006
|
+
locationTaxId?: string;
|
|
20007
|
+
/**
|
|
20008
|
+
* Format: uuid
|
|
20009
|
+
* @deprecated
|
|
20010
|
+
* @description Deprecated. Use customer instead.
|
|
20011
|
+
*/
|
|
20012
|
+
membershipRef?: string;
|
|
20013
|
+
/**
|
|
20014
|
+
* Format: uuid
|
|
20015
|
+
* @deprecated
|
|
20016
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
20017
|
+
*/
|
|
20018
|
+
membershipRefCreator?: string;
|
|
20019
|
+
/**
|
|
20020
|
+
* Format: uuid
|
|
20021
|
+
* @description ID of the network.
|
|
20022
|
+
*/
|
|
20023
|
+
networkRef: string;
|
|
20024
|
+
/**
|
|
20025
|
+
* @deprecated
|
|
20026
|
+
* @description Deprecated. Use product instead.
|
|
20027
|
+
*/
|
|
20028
|
+
order?: {
|
|
20029
|
+
/**
|
|
20030
|
+
* Format: uuid
|
|
20031
|
+
* @description Order id.
|
|
20032
|
+
*/
|
|
20033
|
+
id: string;
|
|
20034
|
+
/** @description Order items. */
|
|
20035
|
+
items: {
|
|
20036
|
+
/**
|
|
20037
|
+
* Format: uuid
|
|
20038
|
+
* @description Order item id.
|
|
20039
|
+
*/
|
|
20040
|
+
id: string;
|
|
20041
|
+
/** @description Ordered product. */
|
|
20042
|
+
product: {
|
|
20043
|
+
/**
|
|
20044
|
+
* Format: uuid
|
|
20045
|
+
* @description Product id.
|
|
20046
|
+
*/
|
|
20047
|
+
id: string;
|
|
20048
|
+
/** @description Product option. */
|
|
20049
|
+
option?: {
|
|
20050
|
+
/**
|
|
20051
|
+
* Format: uuid
|
|
20052
|
+
* @description Product option id.
|
|
20053
|
+
*/
|
|
20054
|
+
id: string;
|
|
20055
|
+
/** @description Product option title. */
|
|
20056
|
+
title: string;
|
|
20057
|
+
};
|
|
20058
|
+
/** @description Product title. */
|
|
20059
|
+
title: string;
|
|
20060
|
+
};
|
|
20061
|
+
/** @description Quantity of units. */
|
|
20062
|
+
quantity: number;
|
|
20063
|
+
}[];
|
|
20064
|
+
};
|
|
20065
|
+
/** @description Payment details. */
|
|
20066
|
+
payment: {
|
|
20067
|
+
/** @description Payment dispute details. */
|
|
20068
|
+
dispute?: {
|
|
20069
|
+
/**
|
|
20070
|
+
* Format: date-time
|
|
20071
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
20072
|
+
*/
|
|
20073
|
+
createDate: string;
|
|
20074
|
+
};
|
|
20075
|
+
/** @description Payment method used. */
|
|
20076
|
+
method: {
|
|
20077
|
+
/** @description Present when type is external. */
|
|
20078
|
+
external?: Record<string, never>;
|
|
20079
|
+
/** @description Present when type is paymentGateway. */
|
|
20080
|
+
paymentGateway?: {
|
|
20081
|
+
/** @description Payment gateway identifier. */
|
|
20082
|
+
gateway: string;
|
|
20083
|
+
/** @description Display label for the payment method. */
|
|
20084
|
+
label?: string;
|
|
20085
|
+
/** @description Masked card or account identifier. */
|
|
20086
|
+
mask?: string;
|
|
20087
|
+
/** @description Display title for the payment gateway. */
|
|
20088
|
+
title?: string;
|
|
20089
|
+
};
|
|
20090
|
+
/**
|
|
20091
|
+
* @description Payment method type.
|
|
20092
|
+
* @enum {string}
|
|
20093
|
+
*/
|
|
20094
|
+
type: "external" | "paymentGateway";
|
|
20095
|
+
};
|
|
20096
|
+
/** @description Payment price details. */
|
|
20097
|
+
price: {
|
|
20098
|
+
money: {
|
|
20099
|
+
/** @description ISO currency code. */
|
|
20100
|
+
currencyCode: string;
|
|
20101
|
+
/** @description Payment amount in major units. */
|
|
20102
|
+
grossAmount: number;
|
|
20103
|
+
};
|
|
20104
|
+
/** @enum {string} */
|
|
20105
|
+
type: "money";
|
|
20106
|
+
};
|
|
20107
|
+
/** @description Whether this payment can be refunded. */
|
|
20108
|
+
refundable: boolean;
|
|
20109
|
+
/** @description Refunds issued against this payment. */
|
|
20110
|
+
refunds?: {
|
|
20111
|
+
money: {
|
|
20112
|
+
/**
|
|
20113
|
+
* Format: date-time
|
|
20114
|
+
* @description Refund creation timestamp.
|
|
20115
|
+
*/
|
|
20116
|
+
createDate: string;
|
|
20117
|
+
/** @description ISO currency code. */
|
|
20118
|
+
currencyCode: string;
|
|
20119
|
+
/**
|
|
20120
|
+
* Format: uuid
|
|
20121
|
+
* @description ID of the customer the user who created the refund belongs to.
|
|
20122
|
+
*/
|
|
20123
|
+
customerRefCreatedBy?: string;
|
|
20124
|
+
/** @description Refunded amount in major units. */
|
|
20125
|
+
grossAmount: number;
|
|
20126
|
+
/**
|
|
20127
|
+
* Format: uuid
|
|
20128
|
+
* @description Refund id.
|
|
20129
|
+
*/
|
|
20130
|
+
id: string;
|
|
20131
|
+
/** @description Who initiated the refund: `spacebring` for a refund issued in Spacebring, `stripe` for one issued in the Stripe dashboard. */
|
|
20132
|
+
initiator?: string;
|
|
20133
|
+
/** @description User who created the refund. */
|
|
20134
|
+
userCreatedBy?: {
|
|
20135
|
+
about?: string | null;
|
|
20136
|
+
email?: string | null;
|
|
20137
|
+
/** Format: uuid */
|
|
20138
|
+
id: string;
|
|
20139
|
+
name?: string | null;
|
|
20140
|
+
phoneNumber?: string | null;
|
|
20141
|
+
photoUrl?: string | null;
|
|
20142
|
+
surname?: string | null;
|
|
20143
|
+
};
|
|
20144
|
+
}[];
|
|
20145
|
+
/** @enum {string} */
|
|
20146
|
+
type: "money";
|
|
20147
|
+
};
|
|
20148
|
+
/** @description Payment surcharge details. */
|
|
20149
|
+
surcharge?: {
|
|
20150
|
+
money: {
|
|
20151
|
+
/** @description Surcharge amount in major units. */
|
|
20152
|
+
amount: number;
|
|
20153
|
+
/** @description ISO currency code. */
|
|
20154
|
+
currencyCode: string;
|
|
20155
|
+
/** @description Surcharge percentage. */
|
|
20156
|
+
percentage?: number;
|
|
20157
|
+
/** @description Surcharge rate. */
|
|
20158
|
+
rate?: number;
|
|
20159
|
+
};
|
|
20160
|
+
/** @enum {string} */
|
|
20161
|
+
type: "money";
|
|
20162
|
+
};
|
|
20163
|
+
};
|
|
20164
|
+
/**
|
|
20165
|
+
* @deprecated
|
|
20166
|
+
* @description Deprecated. Use payment.method instead.
|
|
20167
|
+
*/
|
|
20168
|
+
paymentMethod: {
|
|
20169
|
+
/** @description Display label of the payment method. */
|
|
20170
|
+
label?: string;
|
|
20171
|
+
/** @description Payment gateway identifier, or external. */
|
|
20172
|
+
type: string;
|
|
20173
|
+
};
|
|
20174
|
+
/**
|
|
20175
|
+
* @deprecated
|
|
20176
|
+
* @description Deprecated. Use product instead.
|
|
20177
|
+
*/
|
|
20178
|
+
plan?: {
|
|
20179
|
+
/**
|
|
20180
|
+
* Format: uuid
|
|
20181
|
+
* @description Plan id.
|
|
20182
|
+
*/
|
|
20183
|
+
id: string;
|
|
20184
|
+
/** @description Plan title. */
|
|
20185
|
+
title: string;
|
|
20186
|
+
};
|
|
20187
|
+
/** @description Product details. */
|
|
20188
|
+
product?: {
|
|
20189
|
+
/**
|
|
20190
|
+
* Format: uuid
|
|
20191
|
+
* @description ID of the associated booking.
|
|
20192
|
+
*/
|
|
20193
|
+
bookingRef?: string;
|
|
20194
|
+
/**
|
|
20195
|
+
* Format: uuid
|
|
20196
|
+
* @description ID of the associated event ticket.
|
|
20197
|
+
*/
|
|
20198
|
+
eventTicketRef?: string;
|
|
20199
|
+
/**
|
|
20200
|
+
* Format: uuid
|
|
20201
|
+
* @description ID of the associated invoice.
|
|
20202
|
+
*/
|
|
20203
|
+
invoiceRef?: string;
|
|
20204
|
+
/**
|
|
20205
|
+
* Format: uuid
|
|
20206
|
+
* @description ID of the associated order.
|
|
20207
|
+
*/
|
|
20208
|
+
orderRef?: string;
|
|
20209
|
+
/**
|
|
20210
|
+
* Format: uuid
|
|
20211
|
+
* @description ID of the associated subscription.
|
|
20212
|
+
*/
|
|
20213
|
+
subscriptionRef?: string;
|
|
20214
|
+
/** @description Display title of the product. */
|
|
18275
20215
|
title?: string;
|
|
20216
|
+
/**
|
|
20217
|
+
* @description Product type.
|
|
20218
|
+
* @enum {string}
|
|
20219
|
+
*/
|
|
20220
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
20221
|
+
};
|
|
20222
|
+
/** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
|
|
20223
|
+
receiptPdfUrl?: string;
|
|
20224
|
+
/**
|
|
20225
|
+
* @deprecated
|
|
20226
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
20227
|
+
*/
|
|
20228
|
+
refund?: {
|
|
20229
|
+
/** @description Refunded amount. */
|
|
20230
|
+
amount: number;
|
|
20231
|
+
/**
|
|
20232
|
+
* Format: date-time
|
|
20233
|
+
* @description Refund creation timestamp.
|
|
20234
|
+
*/
|
|
20235
|
+
createDate: string;
|
|
20236
|
+
};
|
|
20237
|
+
/**
|
|
20238
|
+
* @deprecated
|
|
20239
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
20240
|
+
*/
|
|
20241
|
+
refunds?: {
|
|
20242
|
+
/** @description Refunded amount. */
|
|
20243
|
+
amount: number;
|
|
20244
|
+
/**
|
|
20245
|
+
* Format: date-time
|
|
20246
|
+
* @description Refund creation timestamp.
|
|
20247
|
+
*/
|
|
20248
|
+
createDate: string;
|
|
20249
|
+
/** @description ISO currency code. */
|
|
20250
|
+
currencyCode?: string;
|
|
20251
|
+
/**
|
|
20252
|
+
* Format: uuid
|
|
20253
|
+
* @description Refund id.
|
|
20254
|
+
*/
|
|
20255
|
+
id?: string;
|
|
20256
|
+
/** @description Refund initiator. */
|
|
20257
|
+
initiator?: string;
|
|
20258
|
+
/**
|
|
20259
|
+
* Format: uuid
|
|
20260
|
+
* @description Membership of the user who created the refund.
|
|
20261
|
+
*/
|
|
20262
|
+
membershipRefCreator?: string;
|
|
20263
|
+
/**
|
|
20264
|
+
* Format: uuid
|
|
20265
|
+
* @description Location id.
|
|
20266
|
+
*/
|
|
20267
|
+
organizationRef: string;
|
|
20268
|
+
/** @description User who created the refund. */
|
|
20269
|
+
userCreator?: {
|
|
20270
|
+
about?: string | null;
|
|
20271
|
+
email?: string | null;
|
|
20272
|
+
/** Format: uuid */
|
|
20273
|
+
id: string;
|
|
20274
|
+
name?: string | null;
|
|
20275
|
+
phoneNumber?: string | null;
|
|
20276
|
+
photoUrl?: string | null;
|
|
20277
|
+
surname?: string | null;
|
|
20278
|
+
};
|
|
20279
|
+
/**
|
|
20280
|
+
* Format: uuid
|
|
20281
|
+
* @description User id of the refund creator.
|
|
20282
|
+
*/
|
|
20283
|
+
userRefCreator?: string;
|
|
20284
|
+
}[];
|
|
20285
|
+
/**
|
|
20286
|
+
* @description Transaction status.
|
|
20287
|
+
* @enum {string}
|
|
20288
|
+
*/
|
|
20289
|
+
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
|
|
20290
|
+
/**
|
|
20291
|
+
* @deprecated
|
|
20292
|
+
* @description Deprecated. Use product instead.
|
|
20293
|
+
*/
|
|
20294
|
+
ticket?: {
|
|
20295
|
+
/**
|
|
20296
|
+
* Format: date-time
|
|
20297
|
+
* @description Ticket creation timestamp.
|
|
20298
|
+
*/
|
|
20299
|
+
createDate?: string;
|
|
20300
|
+
/**
|
|
20301
|
+
* Format: date-time
|
|
20302
|
+
* @description ISO timestamp of when the ticket was deleted.
|
|
20303
|
+
*/
|
|
20304
|
+
deleteDate?: string;
|
|
20305
|
+
/** @description Event details. */
|
|
20306
|
+
event?: {
|
|
20307
|
+
/**
|
|
20308
|
+
* Format: date-time
|
|
20309
|
+
* @description Event end date.
|
|
20310
|
+
*/
|
|
20311
|
+
endDate?: string;
|
|
20312
|
+
/**
|
|
20313
|
+
* Format: uuid
|
|
20314
|
+
* @description Event id.
|
|
20315
|
+
*/
|
|
20316
|
+
id: string;
|
|
20317
|
+
/**
|
|
20318
|
+
* Format: date-time
|
|
20319
|
+
* @description Event start date.
|
|
20320
|
+
*/
|
|
20321
|
+
startDate?: string;
|
|
20322
|
+
/** @description Event title. */
|
|
20323
|
+
title: string;
|
|
20324
|
+
};
|
|
20325
|
+
/**
|
|
20326
|
+
* Format: uuid
|
|
20327
|
+
* @description Ticket id.
|
|
20328
|
+
*/
|
|
20329
|
+
id: string;
|
|
20330
|
+
/**
|
|
20331
|
+
* Format: uuid
|
|
20332
|
+
* @description Membership of the user who deleted the ticket.
|
|
20333
|
+
*/
|
|
20334
|
+
membershipRefDeletedBy?: string;
|
|
20335
|
+
/**
|
|
20336
|
+
* @deprecated
|
|
20337
|
+
* @description Ticket price.
|
|
20338
|
+
*/
|
|
20339
|
+
price: {
|
|
20340
|
+
/** @description Amount excluding tax in major units. */
|
|
20341
|
+
netAmount: number;
|
|
20342
|
+
/** @description Tax amount in major units. */
|
|
20343
|
+
taxAmount?: number;
|
|
20344
|
+
};
|
|
20345
|
+
/** @description Number of tickets. */
|
|
20346
|
+
quantity: number;
|
|
20347
|
+
/** @description User who deleted the ticket. */
|
|
20348
|
+
userDeletedBy?: {
|
|
20349
|
+
about?: string | null;
|
|
20350
|
+
email?: string | null;
|
|
20351
|
+
/** Format: uuid */
|
|
20352
|
+
id: string;
|
|
20353
|
+
name?: string | null;
|
|
20354
|
+
phoneNumber?: string | null;
|
|
20355
|
+
photoUrl?: string | null;
|
|
20356
|
+
surname?: string | null;
|
|
20357
|
+
};
|
|
20358
|
+
};
|
|
20359
|
+
/**
|
|
20360
|
+
* @description Money transaction type.
|
|
20361
|
+
* @enum {string}
|
|
20362
|
+
*/
|
|
20363
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
20364
|
+
/**
|
|
20365
|
+
* @deprecated
|
|
20366
|
+
* @description Deprecated. Use customer.user instead.
|
|
20367
|
+
*/
|
|
20368
|
+
user?: {
|
|
20369
|
+
about?: string | null;
|
|
20370
|
+
email?: string | null;
|
|
20371
|
+
/** Format: uuid */
|
|
20372
|
+
id: string;
|
|
20373
|
+
name?: string | null;
|
|
20374
|
+
phoneNumber?: string | null;
|
|
20375
|
+
photoUrl?: string | null;
|
|
20376
|
+
surname?: string | null;
|
|
20377
|
+
};
|
|
20378
|
+
/** @description User who created the transaction. */
|
|
20379
|
+
userCreatedBy?: {
|
|
20380
|
+
about?: string | null;
|
|
20381
|
+
email?: string | null;
|
|
20382
|
+
/** Format: uuid */
|
|
20383
|
+
id: string;
|
|
20384
|
+
name?: string | null;
|
|
20385
|
+
phoneNumber?: string | null;
|
|
20386
|
+
photoUrl?: string | null;
|
|
20387
|
+
surname?: string | null;
|
|
18276
20388
|
};
|
|
18277
|
-
|
|
18278
|
-
|
|
18279
|
-
|
|
20389
|
+
/**
|
|
20390
|
+
* @deprecated
|
|
20391
|
+
* @description Deprecated. Use customer.user instead.
|
|
20392
|
+
*/
|
|
20393
|
+
userOwner?: {
|
|
20394
|
+
about?: string | null;
|
|
20395
|
+
email?: string | null;
|
|
20396
|
+
/** Format: uuid */
|
|
20397
|
+
id: string;
|
|
20398
|
+
name?: string | null;
|
|
20399
|
+
phoneNumber?: string | null;
|
|
20400
|
+
photoUrl?: string | null;
|
|
20401
|
+
surname?: string | null;
|
|
18280
20402
|
};
|
|
20403
|
+
/**
|
|
20404
|
+
* Format: uuid
|
|
20405
|
+
* @deprecated
|
|
20406
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
20407
|
+
*/
|
|
20408
|
+
userRefCreator?: string;
|
|
20409
|
+
/**
|
|
20410
|
+
* Format: uuid
|
|
20411
|
+
* @deprecated
|
|
20412
|
+
* @description Deprecated. Use customer.user instead.
|
|
20413
|
+
*/
|
|
20414
|
+
userRefOwner?: string;
|
|
20415
|
+
};
|
|
20416
|
+
};
|
|
20417
|
+
refundMoneyTransaction: {
|
|
20418
|
+
/** @description The refund that was made. */
|
|
20419
|
+
refund: {
|
|
20420
|
+
/** @description Currency code of the refunded amount. */
|
|
20421
|
+
currencyCode: string;
|
|
20422
|
+
/** @description Refunded amount. */
|
|
20423
|
+
money: number;
|
|
18281
20424
|
};
|
|
18282
|
-
type?: string;
|
|
18283
|
-
user?: components["schemas"]["user"];
|
|
18284
20425
|
};
|
|
18285
20426
|
balance: {
|
|
18286
20427
|
allocation?: number;
|
|
@@ -21152,6 +23293,10 @@ interface components {
|
|
|
21152
23293
|
membershipRefOwner?: string;
|
|
21153
23294
|
/** @description Internal note attached to the booking. */
|
|
21154
23295
|
memo?: string;
|
|
23296
|
+
/** @description Key-value data attached to the booking. Values cannot be objects or arrays. Available only for admins. */
|
|
23297
|
+
metadata?: {
|
|
23298
|
+
[key: string]: unknown;
|
|
23299
|
+
};
|
|
21155
23300
|
/** @description RRULE lines that make the booking repeat, e.g. `RRULE:FREQ=WEEKLY;COUNT=10`. The DTSTART line is derived from startDate. Only a free booking can repeat. */
|
|
21156
23301
|
recurrence?: string[];
|
|
21157
23302
|
/**
|
|
@@ -21175,6 +23320,38 @@ interface components {
|
|
|
21175
23320
|
/** @description Custom title for the booking. */
|
|
21176
23321
|
title?: string;
|
|
21177
23322
|
};
|
|
23323
|
+
/** @description Payment method the booking is paid with. Pass the `external` method to record a payment collected outside Spacebring: `succeeded` confirms the booking, `pending` keeps it tentative until the payment is marked as paid. Omit the field to create a free booking. */
|
|
23324
|
+
paymentMethod?: {
|
|
23325
|
+
/** @description Discounts to apply, echoed from the payment method. An empty array applies none; omitting it picks the best suited coupon. */
|
|
23326
|
+
discounts?: {
|
|
23327
|
+
/** @description Coupon to apply. */
|
|
23328
|
+
coupon?: {
|
|
23329
|
+
/**
|
|
23330
|
+
* Format: uuid
|
|
23331
|
+
* @description Unique identifier of the coupon.
|
|
23332
|
+
*/
|
|
23333
|
+
id: string;
|
|
23334
|
+
};
|
|
23335
|
+
/** @description Promocode that brought the coupon. */
|
|
23336
|
+
promocode?: {
|
|
23337
|
+
/** @description Promocode string. */
|
|
23338
|
+
code: string;
|
|
23339
|
+
};
|
|
23340
|
+
}[];
|
|
23341
|
+
/** @description External payment details: the payment is collected outside Spacebring, so it carries only its status. */
|
|
23342
|
+
external: {
|
|
23343
|
+
/**
|
|
23344
|
+
* @description Whether the payment was already collected (`succeeded`, the default) or is still owed (`pending`), which keeps the purchase tentative until the transaction is marked paid.
|
|
23345
|
+
* @enum {string}
|
|
23346
|
+
*/
|
|
23347
|
+
status?: "pending" | "succeeded";
|
|
23348
|
+
};
|
|
23349
|
+
/**
|
|
23350
|
+
* @description Discriminator of the external payment method.
|
|
23351
|
+
* @enum {string}
|
|
23352
|
+
*/
|
|
23353
|
+
type: "external";
|
|
23354
|
+
};
|
|
21178
23355
|
};
|
|
21179
23356
|
};
|
|
21180
23357
|
};
|
|
@@ -21202,6 +23379,10 @@ interface components {
|
|
|
21202
23379
|
entire?: boolean;
|
|
21203
23380
|
/** @description Internal note attached to the booking. */
|
|
21204
23381
|
memo?: string;
|
|
23382
|
+
/** @description Key-value data to merge into the booking metadata. Keys left out keep their value, and a key set to `null` is removed. Values cannot be objects or arrays. Available only for admins. */
|
|
23383
|
+
metadata?: {
|
|
23384
|
+
[key: string]: unknown;
|
|
23385
|
+
};
|
|
21205
23386
|
/**
|
|
21206
23387
|
* Format: uuid
|
|
21207
23388
|
* @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.
|
|
@@ -22441,6 +24622,103 @@ interface components {
|
|
|
22441
24622
|
};
|
|
22442
24623
|
};
|
|
22443
24624
|
};
|
|
24625
|
+
createMoneyTransaction: {
|
|
24626
|
+
content: {
|
|
24627
|
+
"application/json": {
|
|
24628
|
+
/**
|
|
24629
|
+
* Format: uuid
|
|
24630
|
+
* @description ID of the company or user to charge.
|
|
24631
|
+
*/
|
|
24632
|
+
customerRef: string;
|
|
24633
|
+
/** @description Customer billing address. */
|
|
24634
|
+
customerAddress?: {
|
|
24635
|
+
/** @description City. */
|
|
24636
|
+
city?: string;
|
|
24637
|
+
/** @description ISO country code. */
|
|
24638
|
+
countryCode?: string | null;
|
|
24639
|
+
/** @description Address line 1. */
|
|
24640
|
+
line1?: string;
|
|
24641
|
+
/** @description Address line 2. */
|
|
24642
|
+
line2?: string;
|
|
24643
|
+
/** @description Postal code. */
|
|
24644
|
+
postalCode?: string;
|
|
24645
|
+
/** @description State or region. */
|
|
24646
|
+
state?: string;
|
|
24647
|
+
};
|
|
24648
|
+
/** @description Customer legal name. */
|
|
24649
|
+
customerName?: string;
|
|
24650
|
+
/** @description Customer tax ID. */
|
|
24651
|
+
customerTaxId?: string;
|
|
24652
|
+
/** @description Custom item to charge for. */
|
|
24653
|
+
customItem: {
|
|
24654
|
+
/** @description Custom item currency code. */
|
|
24655
|
+
currencyCode: string;
|
|
24656
|
+
/** @description Custom item description. */
|
|
24657
|
+
description?: string;
|
|
24658
|
+
/** @description Tax details. Required when the location has tax enabled. */
|
|
24659
|
+
tax?: {
|
|
24660
|
+
/** @description Tax rate. */
|
|
24661
|
+
rate: number;
|
|
24662
|
+
};
|
|
24663
|
+
/** @description Custom item unit amount in major units. */
|
|
24664
|
+
unitAmount: number;
|
|
24665
|
+
/** @description Custom item unit quantity. */
|
|
24666
|
+
unitQuantity: number;
|
|
24667
|
+
};
|
|
24668
|
+
/** @description Payment details. */
|
|
24669
|
+
payment: {
|
|
24670
|
+
/** @description Payment method details. */
|
|
24671
|
+
method: {
|
|
24672
|
+
/** @description External payment method, recorded outside the platform. */
|
|
24673
|
+
external?: Record<string, never>;
|
|
24674
|
+
/** @description Payment gateway (card) payment method. */
|
|
24675
|
+
paymentGateway?: {
|
|
24676
|
+
/**
|
|
24677
|
+
* @description Payment gateway provider. Only gateways that support saved payment methods can be charged.
|
|
24678
|
+
* @enum {string}
|
|
24679
|
+
*/
|
|
24680
|
+
gateway: "hyperpay" | "mollie" | "plata" | "stripe" | "tap" | "wayforpay";
|
|
24681
|
+
/**
|
|
24682
|
+
* Format: uuid
|
|
24683
|
+
* @description ID of the saved payment method to charge.
|
|
24684
|
+
*/
|
|
24685
|
+
id?: string | null;
|
|
24686
|
+
};
|
|
24687
|
+
/**
|
|
24688
|
+
* @description Selected payment method type.
|
|
24689
|
+
* @enum {string}
|
|
24690
|
+
*/
|
|
24691
|
+
type: "external" | "paymentGateway";
|
|
24692
|
+
};
|
|
24693
|
+
};
|
|
24694
|
+
};
|
|
24695
|
+
};
|
|
24696
|
+
};
|
|
24697
|
+
patchMoneyTransaction: {
|
|
24698
|
+
content: {
|
|
24699
|
+
"application/json": {
|
|
24700
|
+
/** @description Transaction fields to update. */
|
|
24701
|
+
transaction: {
|
|
24702
|
+
/**
|
|
24703
|
+
* @description New status of the pending external payment: `succeeded` approves it, `canceled` rejects it.
|
|
24704
|
+
* @enum {string}
|
|
24705
|
+
*/
|
|
24706
|
+
status: "canceled" | "succeeded";
|
|
24707
|
+
};
|
|
24708
|
+
};
|
|
24709
|
+
};
|
|
24710
|
+
};
|
|
24711
|
+
refundMoneyTransaction: {
|
|
24712
|
+
content: {
|
|
24713
|
+
"application/json": {
|
|
24714
|
+
/** @description Refund options for the transaction. */
|
|
24715
|
+
transaction?: {
|
|
24716
|
+
/** @description Amount to refund in major units. Defaults to the full refundable amount. */
|
|
24717
|
+
amount?: number;
|
|
24718
|
+
};
|
|
24719
|
+
};
|
|
24720
|
+
};
|
|
24721
|
+
};
|
|
22444
24722
|
createContact: {
|
|
22445
24723
|
content: {
|
|
22446
24724
|
"application/json": {
|
|
@@ -23823,6 +26101,8 @@ interface operations {
|
|
|
23823
26101
|
query?: {
|
|
23824
26102
|
/** @description The id of the company. */
|
|
23825
26103
|
companyRef?: string;
|
|
26104
|
+
/** @description The id of the customer. */
|
|
26105
|
+
customerRef?: string;
|
|
23826
26106
|
/** @description The id of the membership. */
|
|
23827
26107
|
membershipRef?: string;
|
|
23828
26108
|
};
|
|
@@ -27299,6 +29579,8 @@ interface operations {
|
|
|
27299
29579
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
27300
29580
|
nextPageToken?: string;
|
|
27301
29581
|
/** @description Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. Defaults to all bookable types. */
|
|
29582
|
+
type?: string;
|
|
29583
|
+
/** @description Deprecated. Use type instead. */
|
|
27302
29584
|
types?: string;
|
|
27303
29585
|
};
|
|
27304
29586
|
header?: {
|
|
@@ -27625,7 +29907,9 @@ interface operations {
|
|
|
27625
29907
|
"startDate[lt]"?: string;
|
|
27626
29908
|
/** @description Matches bookings with startDate on or before this date (ISO 8601). */
|
|
27627
29909
|
"startDate[lte]"?: string;
|
|
27628
|
-
/** @description UUID of the
|
|
29910
|
+
/** @description UUID of the company whose own bookings to list: bookings the company or its members made, not ones they were added to as attendees. Cannot be combined with customerRef or userRefOwner. */
|
|
29911
|
+
companyRefOwner?: string;
|
|
29912
|
+
/** @description UUID of the customer whose bookings to list, both made and attended. */
|
|
27629
29913
|
customerRef?: string;
|
|
27630
29914
|
/** @description Deprecated. Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
27631
29915
|
endDate?: string;
|
|
@@ -27651,6 +29935,8 @@ interface operations {
|
|
|
27651
29935
|
status?: string;
|
|
27652
29936
|
/** @description Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. Defaults to all bookable types. */
|
|
27653
29937
|
type?: string;
|
|
29938
|
+
/** @description UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Cannot be combined with customerRef or companyRefOwner. */
|
|
29939
|
+
userRefOwner?: string;
|
|
27654
29940
|
/** @description Deprecated. Use type instead. */
|
|
27655
29941
|
types?: string;
|
|
27656
29942
|
};
|
|
@@ -29184,30 +31470,23 @@ interface operations {
|
|
|
29184
31470
|
};
|
|
29185
31471
|
getMoneyTransactions: {
|
|
29186
31472
|
parameters: {
|
|
29187
|
-
query
|
|
29188
|
-
/** @description
|
|
29189
|
-
|
|
29190
|
-
/** @description
|
|
31473
|
+
query?: {
|
|
31474
|
+
/** @description Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
31475
|
+
"createDate[gte]"?: string;
|
|
31476
|
+
/** @description Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
31477
|
+
"createDate[lte]"?: string;
|
|
31478
|
+
/** @description UUID of the company or user whose money transactions to list. */
|
|
31479
|
+
customerRef?: string;
|
|
31480
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29191
31481
|
limit?: number;
|
|
29192
|
-
/** @description
|
|
29193
|
-
|
|
29194
|
-
/** @description The type of transactions */
|
|
29195
|
-
type?: "booking" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
29196
|
-
/** @description The date filter of items. */
|
|
29197
|
-
createDate?: {
|
|
29198
|
-
/**
|
|
29199
|
-
* Format: date-time
|
|
29200
|
-
* @description Get transactions with less createDate. Example: createDate[lte]=2021-05-21T10:00:00Z
|
|
29201
|
-
*/
|
|
29202
|
-
lte?: string;
|
|
29203
|
-
/**
|
|
29204
|
-
* Format: date-time
|
|
29205
|
-
* @description Get transactions with greater createDate. Example: createDate[gte]=2021-05-21T10:00:00Z
|
|
29206
|
-
*/
|
|
29207
|
-
gte?: string;
|
|
29208
|
-
};
|
|
31482
|
+
/** @description UUID of the location whose money transactions to list. */
|
|
31483
|
+
locationRef?: string;
|
|
29209
31484
|
/** @description Token to retrieve the next page of results. */
|
|
29210
|
-
nextPageToken?:
|
|
31485
|
+
nextPageToken?: string;
|
|
31486
|
+
/** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
31487
|
+
status?: string;
|
|
31488
|
+
/** @description Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
|
|
31489
|
+
type?: string;
|
|
29211
31490
|
};
|
|
29212
31491
|
header?: {
|
|
29213
31492
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -29224,10 +31503,39 @@ interface operations {
|
|
|
29224
31503
|
[name: string]: unknown;
|
|
29225
31504
|
};
|
|
29226
31505
|
content: {
|
|
29227
|
-
"application/json":
|
|
29228
|
-
|
|
29229
|
-
|
|
29230
|
-
|
|
31506
|
+
"application/json": components["schemas"]["getMoneyTransactions"];
|
|
31507
|
+
};
|
|
31508
|
+
};
|
|
31509
|
+
/** @description Bad Request */
|
|
31510
|
+
400: {
|
|
31511
|
+
headers: {
|
|
31512
|
+
[name: string]: unknown;
|
|
31513
|
+
};
|
|
31514
|
+
content: {
|
|
31515
|
+
"application/json": components["schemas"]["responseError"];
|
|
31516
|
+
};
|
|
31517
|
+
};
|
|
31518
|
+
};
|
|
31519
|
+
};
|
|
31520
|
+
createMoneyTransaction: {
|
|
31521
|
+
parameters: {
|
|
31522
|
+
query?: never;
|
|
31523
|
+
header?: {
|
|
31524
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31525
|
+
"spacebring-network-id"?: string;
|
|
31526
|
+
};
|
|
31527
|
+
path?: never;
|
|
31528
|
+
cookie?: never;
|
|
31529
|
+
};
|
|
31530
|
+
requestBody: components["requestBodies"]["createMoneyTransaction"];
|
|
31531
|
+
responses: {
|
|
31532
|
+
/** @description Created */
|
|
31533
|
+
201: {
|
|
31534
|
+
headers: {
|
|
31535
|
+
[name: string]: unknown;
|
|
31536
|
+
};
|
|
31537
|
+
content: {
|
|
31538
|
+
"application/json": components["schemas"]["createMoneyTransaction"];
|
|
29231
31539
|
};
|
|
29232
31540
|
};
|
|
29233
31541
|
/** @description Bad Request */
|
|
@@ -29249,8 +31557,8 @@ interface operations {
|
|
|
29249
31557
|
"spacebring-network-id"?: string;
|
|
29250
31558
|
};
|
|
29251
31559
|
path: {
|
|
29252
|
-
/** @description The id of the transaction */
|
|
29253
|
-
|
|
31560
|
+
/** @description The id of the transaction. */
|
|
31561
|
+
transactionId: string;
|
|
29254
31562
|
};
|
|
29255
31563
|
cookie?: never;
|
|
29256
31564
|
};
|
|
@@ -29262,9 +31570,75 @@ interface operations {
|
|
|
29262
31570
|
[name: string]: unknown;
|
|
29263
31571
|
};
|
|
29264
31572
|
content: {
|
|
29265
|
-
"application/json":
|
|
29266
|
-
|
|
29267
|
-
|
|
31573
|
+
"application/json": components["schemas"]["getMoneyTransaction"];
|
|
31574
|
+
};
|
|
31575
|
+
};
|
|
31576
|
+
/** @description Bad Request */
|
|
31577
|
+
400: {
|
|
31578
|
+
headers: {
|
|
31579
|
+
[name: string]: unknown;
|
|
31580
|
+
};
|
|
31581
|
+
content: {
|
|
31582
|
+
"application/json": components["schemas"]["responseError"];
|
|
31583
|
+
};
|
|
31584
|
+
};
|
|
31585
|
+
};
|
|
31586
|
+
};
|
|
31587
|
+
patchMoneyTransaction: {
|
|
31588
|
+
parameters: {
|
|
31589
|
+
query?: never;
|
|
31590
|
+
header?: {
|
|
31591
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31592
|
+
"spacebring-network-id"?: string;
|
|
31593
|
+
};
|
|
31594
|
+
path: {
|
|
31595
|
+
/** @description The id of the transaction. */
|
|
31596
|
+
transactionId: string;
|
|
31597
|
+
};
|
|
31598
|
+
cookie?: never;
|
|
31599
|
+
};
|
|
31600
|
+
requestBody: components["requestBodies"]["patchMoneyTransaction"];
|
|
31601
|
+
responses: {
|
|
31602
|
+
/** @description No Content */
|
|
31603
|
+
204: {
|
|
31604
|
+
headers: {
|
|
31605
|
+
[name: string]: unknown;
|
|
31606
|
+
};
|
|
31607
|
+
content?: never;
|
|
31608
|
+
};
|
|
31609
|
+
/** @description Bad Request */
|
|
31610
|
+
400: {
|
|
31611
|
+
headers: {
|
|
31612
|
+
[name: string]: unknown;
|
|
31613
|
+
};
|
|
31614
|
+
content: {
|
|
31615
|
+
"application/json": components["schemas"]["responseError"];
|
|
31616
|
+
};
|
|
31617
|
+
};
|
|
31618
|
+
};
|
|
31619
|
+
};
|
|
31620
|
+
refundMoneyTransaction: {
|
|
31621
|
+
parameters: {
|
|
31622
|
+
query?: never;
|
|
31623
|
+
header?: {
|
|
31624
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31625
|
+
"spacebring-network-id"?: string;
|
|
31626
|
+
};
|
|
31627
|
+
path: {
|
|
31628
|
+
/** @description The id of the transaction. */
|
|
31629
|
+
transactionId: string;
|
|
31630
|
+
};
|
|
31631
|
+
cookie?: never;
|
|
31632
|
+
};
|
|
31633
|
+
requestBody?: components["requestBodies"]["refundMoneyTransaction"];
|
|
31634
|
+
responses: {
|
|
31635
|
+
/** @description OK */
|
|
31636
|
+
200: {
|
|
31637
|
+
headers: {
|
|
31638
|
+
[name: string]: unknown;
|
|
31639
|
+
};
|
|
31640
|
+
content: {
|
|
31641
|
+
"application/json": components["schemas"]["refundMoneyTransaction"];
|
|
29268
31642
|
};
|
|
29269
31643
|
};
|
|
29270
31644
|
/** @description Bad Request */
|
|
@@ -30031,7 +32405,9 @@ type DayPassScheduledTransaction = NonNullable<operations["getScheduledDayPasses
|
|
|
30031
32405
|
/** A DayPassTransaction entity as returned by the Spacebring API. */
|
|
30032
32406
|
type DayPassTransaction = NonNullable<components["schemas"]["transactionDayPasses"]>;
|
|
30033
32407
|
/** A MoneyTransaction entity as returned by the Spacebring API. */
|
|
30034
|
-
type MoneyTransaction = NonNullable<
|
|
32408
|
+
type MoneyTransaction = NonNullable<operations["getMoneyTransaction"]["responses"][200]["content"]["application/json"]["transaction"]>;
|
|
32409
|
+
/** A Refund entity as returned by the Spacebring API. */
|
|
32410
|
+
type Refund = NonNullable<operations["refundMoneyTransaction"]["responses"][200]["content"]["application/json"]["refund"]>;
|
|
30035
32411
|
/** Query parameters for `sb.transactions.credits.list()`. */
|
|
30036
32412
|
interface GetCreditsTransactionsQuery {
|
|
30037
32413
|
/** @deprecated Use customerRef instead. The id of the company to get transactions for. */
|
|
@@ -30078,21 +32454,22 @@ interface GetDayPassesTransactionsQuery {
|
|
|
30078
32454
|
}
|
|
30079
32455
|
/** Query parameters for `sb.transactions.money.list()`. */
|
|
30080
32456
|
interface GetMoneyTransactionsQuery {
|
|
30081
|
-
/**
|
|
30082
|
-
|
|
30083
|
-
/**
|
|
32457
|
+
/** Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
32458
|
+
"createDate[gte]"?: string;
|
|
32459
|
+
/** Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
32460
|
+
"createDate[lte]"?: string;
|
|
32461
|
+
/** UUID of the company or user whose money transactions to list. */
|
|
32462
|
+
customerRef?: string;
|
|
32463
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
30084
32464
|
limit?: number;
|
|
30085
|
-
/**
|
|
30086
|
-
|
|
30087
|
-
/** The type of transactions */
|
|
30088
|
-
type?: "booking" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
30089
|
-
/** The date filter of items. */
|
|
30090
|
-
createDate?: {
|
|
30091
|
-
lte?: string;
|
|
30092
|
-
gte?: string;
|
|
30093
|
-
};
|
|
32465
|
+
/** UUID of the location whose money transactions to list. */
|
|
32466
|
+
locationRef?: string;
|
|
30094
32467
|
/** Token to retrieve the next page of results. */
|
|
30095
32468
|
nextPageToken?: string;
|
|
32469
|
+
/** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
32470
|
+
status?: string;
|
|
32471
|
+
/** Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
|
|
32472
|
+
type?: string;
|
|
30096
32473
|
}
|
|
30097
32474
|
/** Query parameters for `sb.transactions.credits.scheduled.list()`. */
|
|
30098
32475
|
interface GetScheduledCreditsTransactionsQuery {
|
|
@@ -30120,6 +32497,12 @@ interface GetScheduledDayPassesTransactionsQuery {
|
|
|
30120
32497
|
type CreateCreditsTransactionBody = NonNullable<NonNullable<operations["createCreditsTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
30121
32498
|
/** Request body for `sb.transactions.dayPasses.create()`. */
|
|
30122
32499
|
type CreateDayPassesTransactionBody = NonNullable<NonNullable<operations["createDayPassesTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
32500
|
+
/** Request body for `sb.transactions.money.create()`. */
|
|
32501
|
+
type CreateMoneyTransactionBody = NonNullable<operations["createMoneyTransaction"]["requestBody"]>["content"]["application/json"];
|
|
32502
|
+
/** Request body for `sb.transactions.money.update()`. */
|
|
32503
|
+
type PatchMoneyTransactionBody = NonNullable<NonNullable<operations["patchMoneyTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
32504
|
+
/** Request body for `sb.transactions.money.refund()`. */
|
|
32505
|
+
type RefundMoneyTransactionBody = NonNullable<NonNullable<operations["refundMoneyTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
30123
32506
|
|
|
30124
32507
|
/** A Activity entity as returned by the Spacebring API. */
|
|
30125
32508
|
type Activity = NonNullable<components["schemas"]["ticketActivity"]>;
|
|
@@ -30285,7 +32668,9 @@ interface GetBookingsQuery {
|
|
|
30285
32668
|
"startDate[lt]"?: string;
|
|
30286
32669
|
/** Matches bookings with startDate on or before this date (ISO 8601). */
|
|
30287
32670
|
"startDate[lte]"?: string;
|
|
30288
|
-
/** UUID of the
|
|
32671
|
+
/** UUID of the company whose own bookings to list: bookings the company or its members made, not ones they were added to as attendees. Cannot be combined with customerRef or userRefOwner. */
|
|
32672
|
+
companyRefOwner?: string;
|
|
32673
|
+
/** UUID of the customer whose bookings to list, both made and attended. */
|
|
30289
32674
|
customerRef?: string;
|
|
30290
32675
|
/** @deprecated Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
30291
32676
|
endDate?: string;
|
|
@@ -30311,6 +32696,8 @@ interface GetBookingsQuery {
|
|
|
30311
32696
|
status?: string;
|
|
30312
32697
|
/** Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: hotDesk, dedicatedDesk, office, parkingLot, room, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio, equipment, station. Defaults to all bookable types. */
|
|
30313
32698
|
type?: string;
|
|
32699
|
+
/** UUID of the user whose own bookings to list: bookings the user made, not ones they were added to as an attendee. Cannot be combined with customerRef or companyRefOwner. */
|
|
32700
|
+
userRefOwner?: string;
|
|
30314
32701
|
/** @deprecated Use type instead. */
|
|
30315
32702
|
types?: string;
|
|
30316
32703
|
}
|
|
@@ -30323,12 +32710,14 @@ interface GetResourcesQuery {
|
|
|
30323
32710
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30324
32711
|
nextPageToken?: string;
|
|
30325
32712
|
/** Comma-separated list of resource types to filter by, e.g. `room,hotDesk`. Valid values: dedicatedDesk, equipment, hotDesk, office, parkingLot, room, station, conferenceRoom, eventSpace, meetingRoom, phoneBooth, studio. Defaults to all bookable types. */
|
|
32713
|
+
type?: string;
|
|
32714
|
+
/** @deprecated Use type instead. */
|
|
30326
32715
|
types?: string;
|
|
30327
32716
|
}
|
|
30328
32717
|
/** Request body for `sb.resources.assignments.create()`. */
|
|
30329
32718
|
type CreateAssignmentBody = NonNullable<NonNullable<operations["createAssignment"]["requestBody"]>["content"]["application/json"]["assignment"]>;
|
|
30330
32719
|
/** Request body for `sb.resources.bookings.create()`. */
|
|
30331
|
-
type CreateBookingBody = NonNullable<
|
|
32720
|
+
type CreateBookingBody = NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"];
|
|
30332
32721
|
/** Request body for `sb.resources.create()`. */
|
|
30333
32722
|
type CreateResourceBody = NonNullable<NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"]["resource"]>;
|
|
30334
32723
|
/** Request body for `sb.resources.assignments.update()`. */
|
|
@@ -30703,6 +33092,8 @@ interface GetInvoicesQuery {
|
|
|
30703
33092
|
interface GetUpcomingInvoiceItemsQuery {
|
|
30704
33093
|
/** The id of the company. */
|
|
30705
33094
|
companyRef?: string;
|
|
33095
|
+
/** The id of the customer. */
|
|
33096
|
+
customerRef?: string;
|
|
30706
33097
|
/** The id of the membership. */
|
|
30707
33098
|
membershipRef?: string;
|
|
30708
33099
|
}
|
|
@@ -31145,7 +33536,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
31145
33536
|
}>;
|
|
31146
33537
|
iterate(query?: Omit<GetBookingsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Booking, void, undefined>;
|
|
31147
33538
|
get(bookingId: string, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
31148
|
-
create(
|
|
33539
|
+
create(body: CreateBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
31149
33540
|
update(bookingId: string, body: PatchBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
31150
33541
|
delete(bookingId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
31151
33542
|
};
|
|
@@ -31268,12 +33659,16 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
31268
33659
|
};
|
|
31269
33660
|
};
|
|
31270
33661
|
money: {
|
|
31271
|
-
list(query
|
|
31272
|
-
transactions?: MoneyTransaction[];
|
|
33662
|
+
list(query?: GetMoneyTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
31273
33663
|
nextPageToken?: string;
|
|
33664
|
+
searchQueryNext?: string;
|
|
33665
|
+
transactions: MoneyTransaction[];
|
|
31274
33666
|
}>;
|
|
31275
|
-
iterate(query
|
|
31276
|
-
get(
|
|
33667
|
+
iterate(query?: Omit<GetMoneyTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<MoneyTransaction, void, undefined>;
|
|
33668
|
+
get(transactionId: string, options?: SpacebringRequestOptions): Promise<MoneyTransaction>;
|
|
33669
|
+
create(body: CreateMoneyTransactionBody, options?: SpacebringRequestOptions): Promise<MoneyTransaction>;
|
|
33670
|
+
update(transactionId: string, transaction: PatchMoneyTransactionBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
33671
|
+
refund(transactionId: string, transaction?: RefundMoneyTransactionBody, options?: SpacebringRequestOptions): Promise<Refund>;
|
|
31277
33672
|
};
|
|
31278
33673
|
};
|
|
31279
33674
|
visitors: {
|
|
@@ -31374,4 +33769,4 @@ declare class SpacebringError extends Error {
|
|
|
31374
33769
|
});
|
|
31375
33770
|
}
|
|
31376
33771
|
|
|
31377
|
-
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 CreateAssignmentBody, 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 PatchAssignmentBody, 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 };
|
|
33772
|
+
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 CreateAssignmentBody, 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 CreateMoneyTransactionBody, 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 PatchAssignmentBody, type PatchBookingBody, type PatchGuideBody, type PatchMoneyTransactionBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Refund, type RefundMoneyTransactionBody, 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 };
|