@izak0s/spacebring-api 9.0.0 → 9.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +45 -5
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2792 -158
- package/dist/index.d.ts +2792 -158
- package/dist/index.js +45 -5
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -1431,6 +1431,26 @@ interface paths {
|
|
|
1431
1431
|
patch?: never;
|
|
1432
1432
|
trace?: never;
|
|
1433
1433
|
};
|
|
1434
|
+
"/events/v1/media": {
|
|
1435
|
+
parameters: {
|
|
1436
|
+
query?: never;
|
|
1437
|
+
header?: never;
|
|
1438
|
+
path?: never;
|
|
1439
|
+
cookie?: never;
|
|
1440
|
+
};
|
|
1441
|
+
get?: never;
|
|
1442
|
+
put?: never;
|
|
1443
|
+
/**
|
|
1444
|
+
* Create a media upload
|
|
1445
|
+
* @description Create a media upload for an event cover image. The response carries a presigned URL: send the raw file bytes with a PUT request within a minute, using exactly the headers returned. Once the file is stored, pass the returned key as <code>media[0].key</code> when creating or updating an event within an hour; an image that is not attached by then is discarded. <h3>OAuth</h3>Required scopes: <code>events</code>
|
|
1446
|
+
*/
|
|
1447
|
+
post: operations["createEventMedia"];
|
|
1448
|
+
delete?: never;
|
|
1449
|
+
options?: never;
|
|
1450
|
+
head?: never;
|
|
1451
|
+
patch?: never;
|
|
1452
|
+
trace?: never;
|
|
1453
|
+
};
|
|
1434
1454
|
"/events/tickets/v1": {
|
|
1435
1455
|
parameters: {
|
|
1436
1456
|
query?: never;
|
|
@@ -2605,14 +2625,18 @@ interface paths {
|
|
|
2605
2625
|
*/
|
|
2606
2626
|
get: operations["getMoneyTransactions"];
|
|
2607
2627
|
put?: never;
|
|
2608
|
-
|
|
2628
|
+
/**
|
|
2629
|
+
* Create a money transaction
|
|
2630
|
+
* @description Create a money transaction by charging a customer for a custom item. <h3>OAuth</h3>Required scopes: <code>transactions</code>
|
|
2631
|
+
*/
|
|
2632
|
+
post: operations["createMoneyTransaction"];
|
|
2609
2633
|
delete?: never;
|
|
2610
2634
|
options?: never;
|
|
2611
2635
|
head?: never;
|
|
2612
2636
|
patch?: never;
|
|
2613
2637
|
trace?: never;
|
|
2614
2638
|
};
|
|
2615
|
-
"/transactions/money/v1/{
|
|
2639
|
+
"/transactions/money/v1/{transactionId}": {
|
|
2616
2640
|
parameters: {
|
|
2617
2641
|
query?: never;
|
|
2618
2642
|
header?: never;
|
|
@@ -2629,6 +2653,30 @@ interface paths {
|
|
|
2629
2653
|
delete?: never;
|
|
2630
2654
|
options?: never;
|
|
2631
2655
|
head?: never;
|
|
2656
|
+
/**
|
|
2657
|
+
* Update a money transaction
|
|
2658
|
+
* @description Approve or cancel a pending money transaction paid externally. <h3>OAuth</h3>Required scopes: <code>transactions</code>
|
|
2659
|
+
*/
|
|
2660
|
+
patch: operations["patchMoneyTransaction"];
|
|
2661
|
+
trace?: never;
|
|
2662
|
+
};
|
|
2663
|
+
"/transactions/money/v1/{transactionId}/refund": {
|
|
2664
|
+
parameters: {
|
|
2665
|
+
query?: never;
|
|
2666
|
+
header?: never;
|
|
2667
|
+
path?: never;
|
|
2668
|
+
cookie?: never;
|
|
2669
|
+
};
|
|
2670
|
+
get?: never;
|
|
2671
|
+
put?: never;
|
|
2672
|
+
/**
|
|
2673
|
+
* Refund a money transaction
|
|
2674
|
+
* @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>
|
|
2675
|
+
*/
|
|
2676
|
+
post: operations["refundMoneyTransaction"];
|
|
2677
|
+
delete?: never;
|
|
2678
|
+
options?: never;
|
|
2679
|
+
head?: never;
|
|
2632
2680
|
patch?: never;
|
|
2633
2681
|
trace?: never;
|
|
2634
2682
|
};
|
|
@@ -7035,9 +7083,11 @@ interface components {
|
|
|
7035
7083
|
checkInDate?: string;
|
|
7036
7084
|
/**
|
|
7037
7085
|
* Format: uuid
|
|
7038
|
-
* @description ID of the ticket's check-in in the check-ins service.
|
|
7086
|
+
* @description ID of the ticket's check-in in the check-ins service. Present when check-in is enabled for the event.
|
|
7039
7087
|
*/
|
|
7040
7088
|
checkInRef?: string;
|
|
7089
|
+
/** @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. */
|
|
7090
|
+
code?: string;
|
|
7041
7091
|
/**
|
|
7042
7092
|
* Format: date-time
|
|
7043
7093
|
* @description ISO timestamp of when the ticket was created.
|
|
@@ -7050,6 +7100,8 @@ interface components {
|
|
|
7050
7100
|
deleteDate?: string;
|
|
7051
7101
|
/** @description Event this ticket belongs to. */
|
|
7052
7102
|
event: {
|
|
7103
|
+
/** @description Whether attendees can be checked in, per the check-in setting of the event's location. */
|
|
7104
|
+
checkInEnabled: boolean;
|
|
7053
7105
|
/**
|
|
7054
7106
|
* Format: date-time
|
|
7055
7107
|
* @description ISO timestamp of when the event ends.
|
|
@@ -7451,6 +7503,47 @@ interface components {
|
|
|
7451
7503
|
surname?: string | null;
|
|
7452
7504
|
};
|
|
7453
7505
|
};
|
|
7506
|
+
createEventMedia: {
|
|
7507
|
+
/** @description The created media upload. */
|
|
7508
|
+
media: {
|
|
7509
|
+
/** @description Storage key of the media file. Pass it as media[0].key when creating or updating an event. */
|
|
7510
|
+
key: string;
|
|
7511
|
+
/**
|
|
7512
|
+
* @description MIME type of the image file.
|
|
7513
|
+
* @enum {string}
|
|
7514
|
+
*/
|
|
7515
|
+
mimeType: "image/gif" | "image/jpeg" | "image/png" | "image/webp";
|
|
7516
|
+
/** @description Size of the image file in bytes. */
|
|
7517
|
+
size: number;
|
|
7518
|
+
/**
|
|
7519
|
+
* @description Upload status. pending: the file has not been received yet. uploaded: the file is stored and can be attached to an event. attached: an event references the file.
|
|
7520
|
+
* @enum {string}
|
|
7521
|
+
*/
|
|
7522
|
+
status: "pending" | "uploaded" | "attached";
|
|
7523
|
+
/** @description How to upload the file. Send the raw bytes as the request body, not a multipart form. */
|
|
7524
|
+
upload: {
|
|
7525
|
+
/**
|
|
7526
|
+
* Format: date-time
|
|
7527
|
+
* @description ISO timestamp after which the upload URL is rejected.
|
|
7528
|
+
*/
|
|
7529
|
+
expirationDate: string;
|
|
7530
|
+
/** @description Headers the PUT request must send exactly as given; the signature covers them. */
|
|
7531
|
+
headers: {
|
|
7532
|
+
/** @description Must equal the size declared when the upload was created. */
|
|
7533
|
+
"Content-Length": string;
|
|
7534
|
+
/** @description Must equal the mimeType declared when the upload was created. */
|
|
7535
|
+
"Content-Type": string;
|
|
7536
|
+
};
|
|
7537
|
+
/**
|
|
7538
|
+
* @description HTTP method of the upload request.
|
|
7539
|
+
* @enum {string}
|
|
7540
|
+
*/
|
|
7541
|
+
method: "PUT";
|
|
7542
|
+
/** @description Presigned URL to send the raw file bytes to. */
|
|
7543
|
+
url: string;
|
|
7544
|
+
};
|
|
7545
|
+
};
|
|
7546
|
+
};
|
|
7454
7547
|
post: {
|
|
7455
7548
|
/** @description Number of comments on the post. */
|
|
7456
7549
|
comments: number;
|
|
@@ -7903,6 +7996,15 @@ interface components {
|
|
|
7903
7996
|
timezoneId: string;
|
|
7904
7997
|
location: {
|
|
7905
7998
|
address?: string;
|
|
7999
|
+
/** @description Returned only to client credentials and to users with an admin role in the location. */
|
|
8000
|
+
businessAddress?: {
|
|
8001
|
+
city?: string;
|
|
8002
|
+
countryCode?: string | null;
|
|
8003
|
+
line1?: string;
|
|
8004
|
+
line2?: string;
|
|
8005
|
+
postalCode?: string;
|
|
8006
|
+
state?: string;
|
|
8007
|
+
};
|
|
7906
8008
|
createDate?: components["schemas"]["dateSchema"];
|
|
7907
8009
|
currencyCode?: string;
|
|
7908
8010
|
description?: string;
|
|
@@ -7910,10 +8012,66 @@ interface components {
|
|
|
7910
8012
|
email?: string;
|
|
7911
8013
|
/** Format: uuid */
|
|
7912
8014
|
id?: string;
|
|
8015
|
+
/** @description Returned only to client credentials and to users with an admin role in the location. */
|
|
8016
|
+
legalName?: string;
|
|
7913
8017
|
/** @enum {string} */
|
|
7914
8018
|
locale?: "en" | "es" | "ko" | "uk" | "ru";
|
|
8019
|
+
/** @description Images of the location, newest first. */
|
|
8020
|
+
media?: {
|
|
8021
|
+
height?: number;
|
|
8022
|
+
/** @description Storage key of the image. */
|
|
8023
|
+
key?: string;
|
|
8024
|
+
mime?: string;
|
|
8025
|
+
/** @description Public URL of the image. */
|
|
8026
|
+
url?: string;
|
|
8027
|
+
width?: number;
|
|
8028
|
+
}[];
|
|
7915
8029
|
/** Format: uuid */
|
|
7916
8030
|
networkRef?: string;
|
|
8031
|
+
/** @description Opening hours of the location. */
|
|
8032
|
+
schedule?: {
|
|
8033
|
+
/** @description Opening hours for members. Always applies. */
|
|
8034
|
+
default?: {
|
|
8035
|
+
closedDays?: string[];
|
|
8036
|
+
items?: {
|
|
8037
|
+
days?: {
|
|
8038
|
+
friday?: boolean;
|
|
8039
|
+
monday?: boolean;
|
|
8040
|
+
saturday?: boolean;
|
|
8041
|
+
sunday?: boolean;
|
|
8042
|
+
thursday?: boolean;
|
|
8043
|
+
tuesday?: boolean;
|
|
8044
|
+
wednesday?: boolean;
|
|
8045
|
+
};
|
|
8046
|
+
hours?: {
|
|
8047
|
+
from?: string;
|
|
8048
|
+
to?: string;
|
|
8049
|
+
};
|
|
8050
|
+
}[];
|
|
8051
|
+
};
|
|
8052
|
+
/** @description Stricter opening hours for non-members. Applies only when enabled; otherwise non-members follow the default schedule. */
|
|
8053
|
+
public?: {
|
|
8054
|
+
closedDays?: string[];
|
|
8055
|
+
enabled?: boolean;
|
|
8056
|
+
items?: {
|
|
8057
|
+
days?: {
|
|
8058
|
+
friday?: boolean;
|
|
8059
|
+
monday?: boolean;
|
|
8060
|
+
saturday?: boolean;
|
|
8061
|
+
sunday?: boolean;
|
|
8062
|
+
thursday?: boolean;
|
|
8063
|
+
tuesday?: boolean;
|
|
8064
|
+
wednesday?: boolean;
|
|
8065
|
+
};
|
|
8066
|
+
hours?: {
|
|
8067
|
+
from?: string;
|
|
8068
|
+
to?: string;
|
|
8069
|
+
};
|
|
8070
|
+
}[];
|
|
8071
|
+
};
|
|
8072
|
+
};
|
|
8073
|
+
/** @description Returned only to client credentials and to users with an admin role in the location. */
|
|
8074
|
+
taxId?: string;
|
|
7917
8075
|
timezoneId?: components["schemas"]["timezoneId"];
|
|
7918
8076
|
title?: string;
|
|
7919
8077
|
};
|
|
@@ -8815,6 +8973,11 @@ interface components {
|
|
|
8815
8973
|
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
8816
8974
|
/** @description Booking step size in minutes. */
|
|
8817
8975
|
bookingStepMinutes?: number;
|
|
8976
|
+
/**
|
|
8977
|
+
* @description Whether bookings are measured in hours or in whole days.
|
|
8978
|
+
* @enum {string}
|
|
8979
|
+
*/
|
|
8980
|
+
bookingUnit: "hour" | "day";
|
|
8818
8981
|
/** @description Brivo access group reference. */
|
|
8819
8982
|
brivoGroupRef?: number | null;
|
|
8820
8983
|
/**
|
|
@@ -8870,6 +9033,11 @@ interface components {
|
|
|
8870
9033
|
flatAmount: number;
|
|
8871
9034
|
/** @description Start of this price tier in booking minutes. */
|
|
8872
9035
|
from: number;
|
|
9036
|
+
/**
|
|
9037
|
+
* @description Whether the tier is priced per hour or per day.
|
|
9038
|
+
* @enum {string}
|
|
9039
|
+
*/
|
|
9040
|
+
unit: "hour" | "day";
|
|
8873
9041
|
/** @description Variable price per unit within this tier. */
|
|
8874
9042
|
unitAmount: number;
|
|
8875
9043
|
}[];
|
|
@@ -8943,6 +9111,11 @@ interface components {
|
|
|
8943
9111
|
flatAmount: number;
|
|
8944
9112
|
/** @description Start of this price tier in booking minutes. */
|
|
8945
9113
|
from: number;
|
|
9114
|
+
/**
|
|
9115
|
+
* @description Whether the tier is priced per hour or per day.
|
|
9116
|
+
* @enum {string}
|
|
9117
|
+
*/
|
|
9118
|
+
unit: "hour" | "day";
|
|
8946
9119
|
/** @description Variable price per unit within this tier. */
|
|
8947
9120
|
unitAmount: number;
|
|
8948
9121
|
}[];
|
|
@@ -9424,6 +9597,11 @@ interface components {
|
|
|
9424
9597
|
bookingPermission: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
9425
9598
|
/** @description Booking step size in minutes. */
|
|
9426
9599
|
bookingStepMinutes?: number;
|
|
9600
|
+
/**
|
|
9601
|
+
* @description Whether bookings are measured in hours or in whole days.
|
|
9602
|
+
* @enum {string}
|
|
9603
|
+
*/
|
|
9604
|
+
bookingUnit: "hour" | "day";
|
|
9427
9605
|
/** @description Brivo access group reference. */
|
|
9428
9606
|
brivoGroupRef?: number | null;
|
|
9429
9607
|
/**
|
|
@@ -9479,6 +9657,11 @@ interface components {
|
|
|
9479
9657
|
flatAmount: number;
|
|
9480
9658
|
/** @description Start of this price tier in booking minutes. */
|
|
9481
9659
|
from: number;
|
|
9660
|
+
/**
|
|
9661
|
+
* @description Whether the tier is priced per hour or per day.
|
|
9662
|
+
* @enum {string}
|
|
9663
|
+
*/
|
|
9664
|
+
unit: "hour" | "day";
|
|
9482
9665
|
/** @description Variable price per unit within this tier. */
|
|
9483
9666
|
unitAmount: number;
|
|
9484
9667
|
}[];
|
|
@@ -9552,6 +9735,11 @@ interface components {
|
|
|
9552
9735
|
flatAmount: number;
|
|
9553
9736
|
/** @description Start of this price tier in booking minutes. */
|
|
9554
9737
|
from: number;
|
|
9738
|
+
/**
|
|
9739
|
+
* @description Whether the tier is priced per hour or per day.
|
|
9740
|
+
* @enum {string}
|
|
9741
|
+
*/
|
|
9742
|
+
unit: "hour" | "day";
|
|
9555
9743
|
/** @description Variable price per unit within this tier. */
|
|
9556
9744
|
unitAmount: number;
|
|
9557
9745
|
}[];
|
|
@@ -10251,6 +10439,10 @@ interface components {
|
|
|
10251
10439
|
membershipRefOwner?: string;
|
|
10252
10440
|
/** @description Note attached to the booking. Visible to the booking owner and to admins. */
|
|
10253
10441
|
memo?: string;
|
|
10442
|
+
/** @description Key-value data attached to the booking. Values cannot be objects or arrays. Available only for admins. */
|
|
10443
|
+
metadata?: {
|
|
10444
|
+
[key: string]: unknown;
|
|
10445
|
+
};
|
|
10254
10446
|
/**
|
|
10255
10447
|
* @deprecated
|
|
10256
10448
|
* @description Deprecated. Use `payments` instead.
|
|
@@ -11269,6 +11461,10 @@ interface components {
|
|
|
11269
11461
|
membershipRefOwner?: string;
|
|
11270
11462
|
/** @description Note attached to the booking. Visible to the booking owner and to admins. */
|
|
11271
11463
|
memo?: string;
|
|
11464
|
+
/** @description Key-value data attached to the booking. Values cannot be objects or arrays. Available only for admins. */
|
|
11465
|
+
metadata?: {
|
|
11466
|
+
[key: string]: unknown;
|
|
11467
|
+
};
|
|
11272
11468
|
/**
|
|
11273
11469
|
* @deprecated
|
|
11274
11470
|
* @description Deprecated. Use `payments` instead.
|
|
@@ -15794,6 +15990,8 @@ interface components {
|
|
|
15794
15990
|
key: string;
|
|
15795
15991
|
url: string;
|
|
15796
15992
|
};
|
|
15993
|
+
/** @description Public logo URL derived from the company website. */
|
|
15994
|
+
publicLogoUrl?: string;
|
|
15797
15995
|
/** @description Company name. */
|
|
15798
15996
|
title?: string;
|
|
15799
15997
|
/**
|
|
@@ -15813,6 +16011,11 @@ interface components {
|
|
|
15813
16011
|
surname?: string | null;
|
|
15814
16012
|
};
|
|
15815
16013
|
};
|
|
16014
|
+
/**
|
|
16015
|
+
* Format: uuid
|
|
16016
|
+
* @description ID of the customer the user who created the scheduled transaction belongs to.
|
|
16017
|
+
*/
|
|
16018
|
+
customerRefCreatedBy?: string;
|
|
15816
16019
|
/** @description Discounts applied to the scheduled transaction. */
|
|
15817
16020
|
discounts?: {
|
|
15818
16021
|
/** @description Applied coupon. */
|
|
@@ -15869,7 +16072,7 @@ interface components {
|
|
|
15869
16072
|
/**
|
|
15870
16073
|
* Format: uuid
|
|
15871
16074
|
* @deprecated
|
|
15872
|
-
* @description Deprecated. Use
|
|
16075
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
15873
16076
|
*/
|
|
15874
16077
|
membershipRefCreator?: string;
|
|
15875
16078
|
/**
|
|
@@ -16106,6 +16309,8 @@ interface components {
|
|
|
16106
16309
|
key: string;
|
|
16107
16310
|
url: string;
|
|
16108
16311
|
};
|
|
16312
|
+
/** @description Public logo URL derived from the company website. */
|
|
16313
|
+
publicLogoUrl?: string;
|
|
16109
16314
|
/** @description Company name. */
|
|
16110
16315
|
title?: string;
|
|
16111
16316
|
/**
|
|
@@ -16125,6 +16330,11 @@ interface components {
|
|
|
16125
16330
|
surname?: string | null;
|
|
16126
16331
|
};
|
|
16127
16332
|
};
|
|
16333
|
+
/**
|
|
16334
|
+
* Format: uuid
|
|
16335
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
16336
|
+
*/
|
|
16337
|
+
customerRefCreatedBy?: string;
|
|
16128
16338
|
/** @description Transaction description. */
|
|
16129
16339
|
description?: string;
|
|
16130
16340
|
/** @description Discounts applied to the transaction. */
|
|
@@ -16188,7 +16398,7 @@ interface components {
|
|
|
16188
16398
|
/**
|
|
16189
16399
|
* Format: uuid
|
|
16190
16400
|
* @deprecated
|
|
16191
|
-
* @description Deprecated. Use
|
|
16401
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
16192
16402
|
*/
|
|
16193
16403
|
membershipRefCreator?: string;
|
|
16194
16404
|
/**
|
|
@@ -16500,6 +16710,8 @@ interface components {
|
|
|
16500
16710
|
key: string;
|
|
16501
16711
|
url: string;
|
|
16502
16712
|
};
|
|
16713
|
+
/** @description Public logo URL derived from the company website. */
|
|
16714
|
+
publicLogoUrl?: string;
|
|
16503
16715
|
/** @description Company name. */
|
|
16504
16716
|
title?: string;
|
|
16505
16717
|
/**
|
|
@@ -16519,6 +16731,11 @@ interface components {
|
|
|
16519
16731
|
surname?: string | null;
|
|
16520
16732
|
};
|
|
16521
16733
|
};
|
|
16734
|
+
/**
|
|
16735
|
+
* Format: uuid
|
|
16736
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
16737
|
+
*/
|
|
16738
|
+
customerRefCreatedBy?: string;
|
|
16522
16739
|
/** @description Transaction description. */
|
|
16523
16740
|
description?: string;
|
|
16524
16741
|
/** @description Discounts applied to the transaction. */
|
|
@@ -16582,7 +16799,7 @@ interface components {
|
|
|
16582
16799
|
/**
|
|
16583
16800
|
* Format: uuid
|
|
16584
16801
|
* @deprecated
|
|
16585
|
-
* @description Deprecated. Use
|
|
16802
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
16586
16803
|
*/
|
|
16587
16804
|
membershipRefCreator?: string;
|
|
16588
16805
|
/**
|
|
@@ -16892,6 +17109,8 @@ interface components {
|
|
|
16892
17109
|
key: string;
|
|
16893
17110
|
url: string;
|
|
16894
17111
|
};
|
|
17112
|
+
/** @description Public logo URL derived from the company website. */
|
|
17113
|
+
publicLogoUrl?: string;
|
|
16895
17114
|
/** @description Company name. */
|
|
16896
17115
|
title?: string;
|
|
16897
17116
|
/**
|
|
@@ -16911,6 +17130,11 @@ interface components {
|
|
|
16911
17130
|
surname?: string | null;
|
|
16912
17131
|
};
|
|
16913
17132
|
};
|
|
17133
|
+
/**
|
|
17134
|
+
* Format: uuid
|
|
17135
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
17136
|
+
*/
|
|
17137
|
+
customerRefCreatedBy?: string;
|
|
16914
17138
|
/** @description Transaction description. */
|
|
16915
17139
|
description?: string;
|
|
16916
17140
|
/** @description Discounts applied to the transaction. */
|
|
@@ -16974,7 +17198,7 @@ interface components {
|
|
|
16974
17198
|
/**
|
|
16975
17199
|
* Format: uuid
|
|
16976
17200
|
* @deprecated
|
|
16977
|
-
* @description Deprecated. Use
|
|
17201
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
16978
17202
|
*/
|
|
16979
17203
|
membershipRefCreator?: string;
|
|
16980
17204
|
/**
|
|
@@ -17257,6 +17481,8 @@ interface components {
|
|
|
17257
17481
|
key: string;
|
|
17258
17482
|
url: string;
|
|
17259
17483
|
};
|
|
17484
|
+
/** @description Public logo URL derived from the company website. */
|
|
17485
|
+
publicLogoUrl?: string;
|
|
17260
17486
|
/** @description Company name. */
|
|
17261
17487
|
title?: string;
|
|
17262
17488
|
/**
|
|
@@ -17276,6 +17502,11 @@ interface components {
|
|
|
17276
17502
|
surname?: string | null;
|
|
17277
17503
|
};
|
|
17278
17504
|
};
|
|
17505
|
+
/**
|
|
17506
|
+
* Format: uuid
|
|
17507
|
+
* @description ID of the customer the user who created the scheduled transaction belongs to.
|
|
17508
|
+
*/
|
|
17509
|
+
customerRefCreatedBy?: string;
|
|
17279
17510
|
/**
|
|
17280
17511
|
* Format: uuid
|
|
17281
17512
|
* @description Unique identifier of the scheduled transaction.
|
|
@@ -17295,7 +17526,7 @@ interface components {
|
|
|
17295
17526
|
/**
|
|
17296
17527
|
* Format: uuid
|
|
17297
17528
|
* @deprecated
|
|
17298
|
-
* @description Deprecated. Use
|
|
17529
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
17299
17530
|
*/
|
|
17300
17531
|
membershipRefCreator?: string;
|
|
17301
17532
|
/**
|
|
@@ -17522,6 +17753,8 @@ interface components {
|
|
|
17522
17753
|
key: string;
|
|
17523
17754
|
url: string;
|
|
17524
17755
|
};
|
|
17756
|
+
/** @description Public logo URL derived from the company website. */
|
|
17757
|
+
publicLogoUrl?: string;
|
|
17525
17758
|
/** @description Company name. */
|
|
17526
17759
|
title?: string;
|
|
17527
17760
|
/**
|
|
@@ -17541,6 +17774,11 @@ interface components {
|
|
|
17541
17774
|
surname?: string | null;
|
|
17542
17775
|
};
|
|
17543
17776
|
};
|
|
17777
|
+
/**
|
|
17778
|
+
* Format: uuid
|
|
17779
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
17780
|
+
*/
|
|
17781
|
+
customerRefCreatedBy?: string;
|
|
17544
17782
|
/** @description Transaction description. */
|
|
17545
17783
|
description?: string;
|
|
17546
17784
|
/**
|
|
@@ -17562,7 +17800,7 @@ interface components {
|
|
|
17562
17800
|
/**
|
|
17563
17801
|
* Format: uuid
|
|
17564
17802
|
* @deprecated
|
|
17565
|
-
* @description Deprecated. Use
|
|
17803
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
17566
17804
|
*/
|
|
17567
17805
|
membershipRefCreator?: string;
|
|
17568
17806
|
/**
|
|
@@ -17784,6 +18022,8 @@ interface components {
|
|
|
17784
18022
|
key: string;
|
|
17785
18023
|
url: string;
|
|
17786
18024
|
};
|
|
18025
|
+
/** @description Public logo URL derived from the company website. */
|
|
18026
|
+
publicLogoUrl?: string;
|
|
17787
18027
|
/** @description Company name. */
|
|
17788
18028
|
title?: string;
|
|
17789
18029
|
/**
|
|
@@ -17803,6 +18043,11 @@ interface components {
|
|
|
17803
18043
|
surname?: string | null;
|
|
17804
18044
|
};
|
|
17805
18045
|
};
|
|
18046
|
+
/**
|
|
18047
|
+
* Format: uuid
|
|
18048
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
18049
|
+
*/
|
|
18050
|
+
customerRefCreatedBy?: string;
|
|
17806
18051
|
/** @description Transaction description. */
|
|
17807
18052
|
description?: string;
|
|
17808
18053
|
/**
|
|
@@ -17824,7 +18069,7 @@ interface components {
|
|
|
17824
18069
|
/**
|
|
17825
18070
|
* Format: uuid
|
|
17826
18071
|
* @deprecated
|
|
17827
|
-
* @description Deprecated. Use
|
|
18072
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
17828
18073
|
*/
|
|
17829
18074
|
membershipRefCreator?: string;
|
|
17830
18075
|
/**
|
|
@@ -18044,6 +18289,8 @@ interface components {
|
|
|
18044
18289
|
key: string;
|
|
18045
18290
|
url: string;
|
|
18046
18291
|
};
|
|
18292
|
+
/** @description Public logo URL derived from the company website. */
|
|
18293
|
+
publicLogoUrl?: string;
|
|
18047
18294
|
/** @description Company name. */
|
|
18048
18295
|
title?: string;
|
|
18049
18296
|
/**
|
|
@@ -18063,6 +18310,11 @@ interface components {
|
|
|
18063
18310
|
surname?: string | null;
|
|
18064
18311
|
};
|
|
18065
18312
|
};
|
|
18313
|
+
/**
|
|
18314
|
+
* Format: uuid
|
|
18315
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
18316
|
+
*/
|
|
18317
|
+
customerRefCreatedBy?: string;
|
|
18066
18318
|
/** @description Transaction description. */
|
|
18067
18319
|
description?: string;
|
|
18068
18320
|
/**
|
|
@@ -18084,7 +18336,7 @@ interface components {
|
|
|
18084
18336
|
/**
|
|
18085
18337
|
* Format: uuid
|
|
18086
18338
|
* @deprecated
|
|
18087
|
-
* @description Deprecated. Use
|
|
18339
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
18088
18340
|
*/
|
|
18089
18341
|
membershipRefCreator?: string;
|
|
18090
18342
|
/**
|
|
@@ -18193,94 +18445,2139 @@ interface components {
|
|
|
18193
18445
|
*/
|
|
18194
18446
|
userRefOwner?: string;
|
|
18195
18447
|
};
|
|
18196
|
-
|
|
18197
|
-
|
|
18198
|
-
|
|
18199
|
-
|
|
18200
|
-
|
|
18201
|
-
|
|
18202
|
-
|
|
18203
|
-
|
|
18204
|
-
|
|
18205
|
-
|
|
18206
|
-
|
|
18207
|
-
|
|
18208
|
-
|
|
18209
|
-
|
|
18210
|
-
|
|
18211
|
-
|
|
18212
|
-
|
|
18213
|
-
|
|
18214
|
-
|
|
18215
|
-
|
|
18216
|
-
|
|
18217
|
-
|
|
18218
|
-
|
|
18219
|
-
|
|
18220
|
-
|
|
18221
|
-
|
|
18222
|
-
|
|
18223
|
-
|
|
18224
|
-
|
|
18225
|
-
|
|
18226
|
-
|
|
18227
|
-
|
|
18228
|
-
|
|
18229
|
-
|
|
18230
|
-
|
|
18231
|
-
|
|
18232
|
-
|
|
18233
|
-
|
|
18234
|
-
|
|
18235
|
-
|
|
18236
|
-
|
|
18237
|
-
|
|
18238
|
-
|
|
18239
|
-
|
|
18240
|
-
|
|
18241
|
-
|
|
18242
|
-
|
|
18243
|
-
|
|
18244
|
-
|
|
18245
|
-
|
|
18246
|
-
|
|
18247
|
-
|
|
18448
|
+
getMoneyTransactions: {
|
|
18449
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
18450
|
+
nextPageToken?: string;
|
|
18451
|
+
/** @description Search query parameters for the next page of results. Includes all filters used to fetch the current page. */
|
|
18452
|
+
searchQueryNext?: string;
|
|
18453
|
+
/** @description List of money transactions. */
|
|
18454
|
+
transactions: {
|
|
18455
|
+
/** @description Transaction amount in major units. */
|
|
18456
|
+
amount: number;
|
|
18457
|
+
/**
|
|
18458
|
+
* @deprecated
|
|
18459
|
+
* @description Deprecated. Use locationAddress instead.
|
|
18460
|
+
*/
|
|
18461
|
+
billingAddressBy?: string;
|
|
18462
|
+
/**
|
|
18463
|
+
* @deprecated
|
|
18464
|
+
* @description Deprecated. Use customerAddress instead.
|
|
18465
|
+
*/
|
|
18466
|
+
billingAddressTo?: string;
|
|
18467
|
+
/**
|
|
18468
|
+
* @deprecated
|
|
18469
|
+
* @description Deprecated. Use product instead.
|
|
18470
|
+
*/
|
|
18471
|
+
booking?: {
|
|
18472
|
+
/**
|
|
18473
|
+
* Format: date-time
|
|
18474
|
+
* @description ISO timestamp of when the booking was deleted.
|
|
18475
|
+
*/
|
|
18476
|
+
deleteDate?: string;
|
|
18477
|
+
/**
|
|
18478
|
+
* Format: date-time
|
|
18479
|
+
* @description Booking end date.
|
|
18480
|
+
*/
|
|
18481
|
+
endDate?: string;
|
|
18482
|
+
/**
|
|
18483
|
+
* Format: uuid
|
|
18484
|
+
* @description Booking id.
|
|
18485
|
+
*/
|
|
18486
|
+
id: string;
|
|
18487
|
+
/**
|
|
18488
|
+
* Format: uuid
|
|
18489
|
+
* @description Membership of the user who deleted the booking.
|
|
18490
|
+
*/
|
|
18491
|
+
membershipRefDeletedBy?: string;
|
|
18492
|
+
/**
|
|
18493
|
+
* @deprecated
|
|
18494
|
+
* @description Booking price.
|
|
18495
|
+
*/
|
|
18496
|
+
price: {
|
|
18497
|
+
/** @description Amount excluding tax in major units. */
|
|
18498
|
+
netAmount: number;
|
|
18499
|
+
/** @description Tax amount in major units. */
|
|
18500
|
+
taxAmount?: number;
|
|
18501
|
+
};
|
|
18502
|
+
/** @description Booked resource. */
|
|
18503
|
+
resource: {
|
|
18504
|
+
/**
|
|
18505
|
+
* Format: uuid
|
|
18506
|
+
* @description Resource id.
|
|
18507
|
+
*/
|
|
18508
|
+
id: string;
|
|
18509
|
+
/** @description Resource title. */
|
|
18510
|
+
title: string;
|
|
18511
|
+
};
|
|
18512
|
+
/**
|
|
18513
|
+
* Format: date-time
|
|
18514
|
+
* @description Booking start date.
|
|
18515
|
+
*/
|
|
18516
|
+
startDate?: string;
|
|
18517
|
+
/** @description User who deleted the booking. */
|
|
18518
|
+
userDeletedBy?: {
|
|
18519
|
+
about?: string | null;
|
|
18520
|
+
email?: string | null;
|
|
18521
|
+
/** Format: uuid */
|
|
18522
|
+
id: string;
|
|
18523
|
+
name?: string | null;
|
|
18524
|
+
phoneNumber?: string | null;
|
|
18525
|
+
photoUrl?: string | null;
|
|
18526
|
+
surname?: string | null;
|
|
18527
|
+
};
|
|
18248
18528
|
};
|
|
18249
|
-
|
|
18250
|
-
|
|
18251
|
-
|
|
18252
|
-
|
|
18253
|
-
|
|
18254
|
-
|
|
18255
|
-
|
|
18256
|
-
|
|
18257
|
-
|
|
18258
|
-
|
|
18259
|
-
|
|
18260
|
-
|
|
18261
|
-
|
|
18262
|
-
|
|
18263
|
-
|
|
18264
|
-
|
|
18265
|
-
|
|
18266
|
-
|
|
18267
|
-
|
|
18268
|
-
|
|
18269
|
-
|
|
18270
|
-
|
|
18271
|
-
|
|
18529
|
+
/**
|
|
18530
|
+
* @deprecated
|
|
18531
|
+
* @description Deprecated. Use customer instead.
|
|
18532
|
+
*/
|
|
18533
|
+
company?: {
|
|
18534
|
+
/**
|
|
18535
|
+
* Format: date-time
|
|
18536
|
+
* @description ISO timestamp of company creation.
|
|
18537
|
+
*/
|
|
18538
|
+
createDate: string;
|
|
18539
|
+
/**
|
|
18540
|
+
* Format: uuid
|
|
18541
|
+
* @description Company id.
|
|
18542
|
+
*/
|
|
18543
|
+
id: string;
|
|
18544
|
+
/**
|
|
18545
|
+
* Format: uuid
|
|
18546
|
+
* @description Location id.
|
|
18547
|
+
*/
|
|
18548
|
+
locationRef: string;
|
|
18549
|
+
/** @description Company metadata. */
|
|
18550
|
+
metadata?: {
|
|
18551
|
+
[key: string]: unknown;
|
|
18552
|
+
};
|
|
18553
|
+
/** @description Internal notes. */
|
|
18554
|
+
notes?: string;
|
|
18555
|
+
/**
|
|
18556
|
+
* Format: uuid
|
|
18557
|
+
* @description Primary subscription id.
|
|
18558
|
+
*/
|
|
18559
|
+
subscriptionRef: string | null;
|
|
18560
|
+
/** @description Company name. */
|
|
18561
|
+
title: string;
|
|
18562
|
+
};
|
|
18563
|
+
/**
|
|
18564
|
+
* Format: uuid
|
|
18565
|
+
* @deprecated
|
|
18566
|
+
* @description Deprecated. Use customer instead.
|
|
18567
|
+
*/
|
|
18568
|
+
companyRef?: string;
|
|
18569
|
+
/**
|
|
18570
|
+
* Format: date-time
|
|
18571
|
+
* @description ISO timestamp of when the transaction was created.
|
|
18572
|
+
*/
|
|
18573
|
+
createDate: string;
|
|
18574
|
+
/**
|
|
18575
|
+
* @deprecated
|
|
18576
|
+
* @description Deprecated. Use product instead.
|
|
18577
|
+
*/
|
|
18578
|
+
creditPackage?: {
|
|
18579
|
+
/** @description Credits amount of the package, or the package price when the package has no credits. */
|
|
18580
|
+
amount: number;
|
|
18581
|
+
/** @description Credits amount of the package. */
|
|
18582
|
+
creditsAmount?: number;
|
|
18583
|
+
/** @description Day passes amount of the package. */
|
|
18584
|
+
dayPassesAmount?: number;
|
|
18585
|
+
/**
|
|
18586
|
+
* @deprecated
|
|
18587
|
+
* @description Package price.
|
|
18588
|
+
*/
|
|
18589
|
+
price: {
|
|
18590
|
+
/** @description Amount excluding tax in major units. */
|
|
18591
|
+
netAmount: number;
|
|
18592
|
+
/** @description Tax amount in major units. */
|
|
18593
|
+
taxAmount?: number;
|
|
18594
|
+
};
|
|
18595
|
+
};
|
|
18596
|
+
/** @description ISO currency code. */
|
|
18597
|
+
currencyCode: string;
|
|
18598
|
+
/** @description Customer associated with this transaction. */
|
|
18599
|
+
customer?: {
|
|
18600
|
+
/**
|
|
18601
|
+
* Format: uuid
|
|
18602
|
+
* @description ID of the company or user.
|
|
18603
|
+
*/
|
|
18604
|
+
id: string;
|
|
18605
|
+
/** @description Company logo. */
|
|
18606
|
+
logo?: {
|
|
18607
|
+
key: string;
|
|
18608
|
+
url: string;
|
|
18609
|
+
};
|
|
18610
|
+
/** @description Public logo URL derived from the company website. */
|
|
18611
|
+
publicLogoUrl?: string;
|
|
18612
|
+
/** @description Company name. */
|
|
18613
|
+
title?: string;
|
|
18614
|
+
/**
|
|
18615
|
+
* @description Whether the customer is a company or a user.
|
|
18616
|
+
* @enum {string}
|
|
18617
|
+
*/
|
|
18618
|
+
type: "company" | "user";
|
|
18619
|
+
/** @description User details for user customers. */
|
|
18620
|
+
user?: {
|
|
18621
|
+
about?: string | null;
|
|
18622
|
+
email?: string | null;
|
|
18623
|
+
/** Format: uuid */
|
|
18624
|
+
id: string;
|
|
18625
|
+
name?: string | null;
|
|
18626
|
+
phoneNumber?: string | null;
|
|
18627
|
+
photoUrl?: string | null;
|
|
18628
|
+
surname?: string | null;
|
|
18629
|
+
};
|
|
18630
|
+
};
|
|
18631
|
+
/**
|
|
18632
|
+
* Format: uuid
|
|
18633
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
18634
|
+
*/
|
|
18635
|
+
customerRefCreatedBy?: string;
|
|
18636
|
+
/** @description Customer billing address. */
|
|
18637
|
+
customerAddress?: {
|
|
18638
|
+
city: string;
|
|
18639
|
+
countryCode: string | null;
|
|
18640
|
+
line1: string;
|
|
18641
|
+
line2: string;
|
|
18642
|
+
postalCode: string;
|
|
18643
|
+
state: string;
|
|
18644
|
+
};
|
|
18645
|
+
/** @description Customer legal name. */
|
|
18646
|
+
customerName?: string;
|
|
18647
|
+
/** @description Customer tax ID. */
|
|
18648
|
+
customerTaxId?: string;
|
|
18649
|
+
/** @description Custom item details. */
|
|
18650
|
+
customItem?: {
|
|
18651
|
+
/** @description Custom item currency code. */
|
|
18652
|
+
currencyCode?: string;
|
|
18653
|
+
/** @description Custom item description. */
|
|
18654
|
+
description?: string;
|
|
18655
|
+
tax?: {
|
|
18656
|
+
/** @description Whether tax is enabled for the custom item. */
|
|
18657
|
+
enabled: boolean;
|
|
18658
|
+
/** @description Tax rate. */
|
|
18659
|
+
rate: number;
|
|
18660
|
+
};
|
|
18661
|
+
/** @description Custom item unit amount in major units. */
|
|
18662
|
+
unitAmount?: number;
|
|
18663
|
+
/** @description Custom item unit quantity. */
|
|
18664
|
+
unitQuantity?: number;
|
|
18665
|
+
};
|
|
18666
|
+
/** @description Discounts applied to the transaction. */
|
|
18667
|
+
discounts?: {
|
|
18668
|
+
/** @description Applied coupon. */
|
|
18669
|
+
coupon: {
|
|
18670
|
+
/** @description Fixed amount discount. */
|
|
18671
|
+
amountOff?: number;
|
|
18672
|
+
/** @description Currency of the fixed amount discount. */
|
|
18673
|
+
currencyCode?: string;
|
|
18674
|
+
/** @description Coupon id. */
|
|
18675
|
+
id?: string;
|
|
18676
|
+
/** @description Percentage discount. */
|
|
18677
|
+
percentOff?: number;
|
|
18678
|
+
/** @description Product types the coupon applies to. */
|
|
18679
|
+
productTypes?: string[];
|
|
18680
|
+
/** @description Coupon type. */
|
|
18681
|
+
type?: string;
|
|
18682
|
+
};
|
|
18683
|
+
/** @description Promocode the coupon was applied with. */
|
|
18684
|
+
promocode?: {
|
|
18685
|
+
/** @description Promocode. */
|
|
18686
|
+
code: string;
|
|
18687
|
+
/** @description Promocode expiration settings. */
|
|
18688
|
+
expiration?: {
|
|
18689
|
+
/**
|
|
18690
|
+
* Format: date-time
|
|
18691
|
+
* @description ISO timestamp when the promocode expires.
|
|
18692
|
+
*/
|
|
18693
|
+
date?: string;
|
|
18694
|
+
/** @description Whether the promocode has an expiration date. */
|
|
18695
|
+
enabled: boolean;
|
|
18696
|
+
};
|
|
18697
|
+
/**
|
|
18698
|
+
* Format: uuid
|
|
18699
|
+
* @description Promocode id.
|
|
18700
|
+
*/
|
|
18701
|
+
id: string;
|
|
18702
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
18703
|
+
limitByFirstPurchase?: boolean;
|
|
18704
|
+
};
|
|
18705
|
+
/**
|
|
18706
|
+
* Format: uuid
|
|
18707
|
+
* @description ID of the subscription this discount is associated with.
|
|
18708
|
+
*/
|
|
18709
|
+
subscriptionId?: string;
|
|
18710
|
+
}[];
|
|
18711
|
+
/** @description Payment gateway error description for failed transactions. */
|
|
18712
|
+
errorDescription?: string;
|
|
18713
|
+
/**
|
|
18714
|
+
* Format: uuid
|
|
18715
|
+
* @description Unique identifier of the transaction.
|
|
18716
|
+
*/
|
|
18717
|
+
id: string;
|
|
18718
|
+
/**
|
|
18719
|
+
* @deprecated
|
|
18720
|
+
* @description Deprecated. Use product instead.
|
|
18721
|
+
*/
|
|
18722
|
+
invoice?: {
|
|
18723
|
+
/**
|
|
18724
|
+
* Format: uuid
|
|
18725
|
+
* @description Invoice id.
|
|
18726
|
+
*/
|
|
18727
|
+
id: string;
|
|
18728
|
+
/** @description Invoice title. */
|
|
18729
|
+
title: string;
|
|
18730
|
+
};
|
|
18731
|
+
/** @description Location billing address. */
|
|
18732
|
+
locationAddress?: {
|
|
18733
|
+
city: string;
|
|
18734
|
+
countryCode: string | null;
|
|
18735
|
+
line1: string;
|
|
18736
|
+
line2: string;
|
|
18737
|
+
postalCode: string;
|
|
18738
|
+
state: string;
|
|
18739
|
+
};
|
|
18740
|
+
/** @description Location legal name. */
|
|
18741
|
+
locationName?: string;
|
|
18742
|
+
/**
|
|
18743
|
+
* Format: uuid
|
|
18744
|
+
* @description ID of the organization (location).
|
|
18745
|
+
*/
|
|
18746
|
+
locationRef: string;
|
|
18747
|
+
/** @description Location tax ID. */
|
|
18748
|
+
locationTaxId?: string;
|
|
18749
|
+
/**
|
|
18750
|
+
* Format: uuid
|
|
18751
|
+
* @deprecated
|
|
18752
|
+
* @description Deprecated. Use customer instead.
|
|
18753
|
+
*/
|
|
18754
|
+
membershipRef?: string;
|
|
18755
|
+
/**
|
|
18756
|
+
* Format: uuid
|
|
18757
|
+
* @deprecated
|
|
18758
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
18759
|
+
*/
|
|
18760
|
+
membershipRefCreator?: string;
|
|
18761
|
+
/**
|
|
18762
|
+
* Format: uuid
|
|
18763
|
+
* @description ID of the network.
|
|
18764
|
+
*/
|
|
18765
|
+
networkRef: string;
|
|
18766
|
+
/**
|
|
18767
|
+
* @deprecated
|
|
18768
|
+
* @description Deprecated. Use product instead.
|
|
18769
|
+
*/
|
|
18770
|
+
order?: {
|
|
18771
|
+
/**
|
|
18772
|
+
* Format: uuid
|
|
18773
|
+
* @description Order id.
|
|
18774
|
+
*/
|
|
18775
|
+
id: string;
|
|
18776
|
+
/** @description Order items. */
|
|
18777
|
+
items: {
|
|
18778
|
+
/**
|
|
18779
|
+
* Format: uuid
|
|
18780
|
+
* @description Order item id.
|
|
18781
|
+
*/
|
|
18782
|
+
id: string;
|
|
18783
|
+
/** @description Ordered product. */
|
|
18784
|
+
product: {
|
|
18785
|
+
/**
|
|
18786
|
+
* Format: uuid
|
|
18787
|
+
* @description Product id.
|
|
18788
|
+
*/
|
|
18789
|
+
id: string;
|
|
18790
|
+
/** @description Product option. */
|
|
18791
|
+
option?: {
|
|
18792
|
+
/**
|
|
18793
|
+
* Format: uuid
|
|
18794
|
+
* @description Product option id.
|
|
18795
|
+
*/
|
|
18796
|
+
id: string;
|
|
18797
|
+
/** @description Product option title. */
|
|
18798
|
+
title: string;
|
|
18799
|
+
};
|
|
18800
|
+
/** @description Product title. */
|
|
18801
|
+
title: string;
|
|
18802
|
+
};
|
|
18803
|
+
/** @description Quantity of units. */
|
|
18804
|
+
quantity: number;
|
|
18805
|
+
}[];
|
|
18806
|
+
};
|
|
18807
|
+
/** @description Payment details. */
|
|
18808
|
+
payment: {
|
|
18809
|
+
/** @description Payment dispute details. */
|
|
18810
|
+
dispute?: {
|
|
18811
|
+
/**
|
|
18812
|
+
* Format: date-time
|
|
18813
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
18814
|
+
*/
|
|
18815
|
+
createDate: string;
|
|
18816
|
+
};
|
|
18817
|
+
/** @description Payment method used. */
|
|
18818
|
+
method: {
|
|
18819
|
+
/** @description Present when type is external. */
|
|
18820
|
+
external?: Record<string, never>;
|
|
18821
|
+
/** @description Present when type is paymentGateway. */
|
|
18822
|
+
paymentGateway?: {
|
|
18823
|
+
/** @description Payment gateway identifier. */
|
|
18824
|
+
gateway: string;
|
|
18825
|
+
/** @description Display label for the payment method. */
|
|
18826
|
+
label?: string;
|
|
18827
|
+
/** @description Masked card or account identifier. */
|
|
18828
|
+
mask?: string;
|
|
18829
|
+
/** @description Display title for the payment gateway. */
|
|
18830
|
+
title?: string;
|
|
18831
|
+
};
|
|
18832
|
+
/**
|
|
18833
|
+
* @description Payment method type.
|
|
18834
|
+
* @enum {string}
|
|
18835
|
+
*/
|
|
18836
|
+
type: "external" | "paymentGateway";
|
|
18837
|
+
};
|
|
18838
|
+
/** @description Payment price details. */
|
|
18839
|
+
price: {
|
|
18840
|
+
money: {
|
|
18841
|
+
/** @description ISO currency code. */
|
|
18842
|
+
currencyCode: string;
|
|
18843
|
+
/** @description Payment amount in major units. */
|
|
18844
|
+
grossAmount: number;
|
|
18845
|
+
};
|
|
18846
|
+
/** @enum {string} */
|
|
18847
|
+
type: "money";
|
|
18848
|
+
};
|
|
18849
|
+
/** @description Whether this payment can be refunded. */
|
|
18850
|
+
refundable: boolean;
|
|
18851
|
+
/** @description Refunds issued against this payment. */
|
|
18852
|
+
refunds?: {
|
|
18853
|
+
money: {
|
|
18854
|
+
/**
|
|
18855
|
+
* Format: date-time
|
|
18856
|
+
* @description Refund creation timestamp.
|
|
18857
|
+
*/
|
|
18858
|
+
createDate: string;
|
|
18859
|
+
/** @description ISO currency code. */
|
|
18860
|
+
currencyCode: string;
|
|
18861
|
+
/**
|
|
18862
|
+
* Format: uuid
|
|
18863
|
+
* @description ID of the customer the user who created the refund belongs to.
|
|
18864
|
+
*/
|
|
18865
|
+
customerRefCreatedBy?: string;
|
|
18866
|
+
/** @description Refunded amount in major units. */
|
|
18867
|
+
grossAmount: number;
|
|
18868
|
+
/**
|
|
18869
|
+
* Format: uuid
|
|
18870
|
+
* @description Refund id.
|
|
18871
|
+
*/
|
|
18872
|
+
id: string;
|
|
18873
|
+
/** @description Who initiated the refund: `spacebring` for a refund issued in Spacebring, `stripe` for one issued in the Stripe dashboard. */
|
|
18874
|
+
initiator?: string;
|
|
18875
|
+
/** @description User who created the refund. */
|
|
18876
|
+
userCreatedBy?: {
|
|
18877
|
+
about?: string | null;
|
|
18878
|
+
email?: string | null;
|
|
18879
|
+
/** Format: uuid */
|
|
18880
|
+
id: string;
|
|
18881
|
+
name?: string | null;
|
|
18882
|
+
phoneNumber?: string | null;
|
|
18883
|
+
photoUrl?: string | null;
|
|
18884
|
+
surname?: string | null;
|
|
18885
|
+
};
|
|
18886
|
+
}[];
|
|
18887
|
+
/** @enum {string} */
|
|
18888
|
+
type: "money";
|
|
18889
|
+
};
|
|
18890
|
+
/** @description Payment surcharge details. */
|
|
18891
|
+
surcharge?: {
|
|
18892
|
+
money: {
|
|
18893
|
+
/** @description Surcharge amount in major units. */
|
|
18894
|
+
amount: number;
|
|
18895
|
+
/** @description ISO currency code. */
|
|
18896
|
+
currencyCode: string;
|
|
18897
|
+
/** @description Surcharge percentage. */
|
|
18898
|
+
percentage?: number;
|
|
18899
|
+
/** @description Surcharge rate. */
|
|
18900
|
+
rate?: number;
|
|
18901
|
+
};
|
|
18902
|
+
/** @enum {string} */
|
|
18903
|
+
type: "money";
|
|
18904
|
+
};
|
|
18905
|
+
};
|
|
18906
|
+
/**
|
|
18907
|
+
* @deprecated
|
|
18908
|
+
* @description Deprecated. Use payment.method instead.
|
|
18909
|
+
*/
|
|
18910
|
+
paymentMethod: {
|
|
18911
|
+
/** @description Display label of the payment method. */
|
|
18912
|
+
label?: string;
|
|
18913
|
+
/** @description Payment gateway identifier, or external. */
|
|
18914
|
+
type: string;
|
|
18915
|
+
};
|
|
18916
|
+
/**
|
|
18917
|
+
* @deprecated
|
|
18918
|
+
* @description Deprecated. Use product instead.
|
|
18919
|
+
*/
|
|
18920
|
+
plan?: {
|
|
18921
|
+
/**
|
|
18922
|
+
* Format: uuid
|
|
18923
|
+
* @description Plan id.
|
|
18924
|
+
*/
|
|
18925
|
+
id: string;
|
|
18926
|
+
/** @description Plan title. */
|
|
18927
|
+
title: string;
|
|
18928
|
+
};
|
|
18929
|
+
/** @description Product details. */
|
|
18930
|
+
product?: {
|
|
18931
|
+
/**
|
|
18932
|
+
* Format: uuid
|
|
18933
|
+
* @description ID of the associated booking.
|
|
18934
|
+
*/
|
|
18935
|
+
bookingRef?: string;
|
|
18936
|
+
/**
|
|
18937
|
+
* Format: uuid
|
|
18938
|
+
* @description ID of the associated event ticket.
|
|
18939
|
+
*/
|
|
18940
|
+
eventTicketRef?: string;
|
|
18941
|
+
/**
|
|
18942
|
+
* Format: uuid
|
|
18943
|
+
* @description ID of the associated invoice.
|
|
18944
|
+
*/
|
|
18945
|
+
invoiceRef?: string;
|
|
18946
|
+
/**
|
|
18947
|
+
* Format: uuid
|
|
18948
|
+
* @description ID of the associated order.
|
|
18949
|
+
*/
|
|
18950
|
+
orderRef?: string;
|
|
18951
|
+
/**
|
|
18952
|
+
* Format: uuid
|
|
18953
|
+
* @description ID of the associated subscription.
|
|
18954
|
+
*/
|
|
18955
|
+
subscriptionRef?: string;
|
|
18956
|
+
/** @description Display title of the product. */
|
|
18957
|
+
title?: string;
|
|
18958
|
+
/**
|
|
18959
|
+
* @description Product type.
|
|
18960
|
+
* @enum {string}
|
|
18961
|
+
*/
|
|
18962
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
18963
|
+
};
|
|
18964
|
+
/** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
|
|
18965
|
+
receiptPdfUrl?: string;
|
|
18966
|
+
/**
|
|
18967
|
+
* @deprecated
|
|
18968
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
18969
|
+
*/
|
|
18970
|
+
refund?: {
|
|
18971
|
+
/** @description Refunded amount. */
|
|
18972
|
+
amount: number;
|
|
18973
|
+
/**
|
|
18974
|
+
* Format: date-time
|
|
18975
|
+
* @description Refund creation timestamp.
|
|
18976
|
+
*/
|
|
18977
|
+
createDate: string;
|
|
18978
|
+
};
|
|
18979
|
+
/**
|
|
18980
|
+
* @deprecated
|
|
18981
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
18982
|
+
*/
|
|
18983
|
+
refunds?: {
|
|
18984
|
+
/** @description Refunded amount. */
|
|
18985
|
+
amount: number;
|
|
18986
|
+
/**
|
|
18987
|
+
* Format: date-time
|
|
18988
|
+
* @description Refund creation timestamp.
|
|
18989
|
+
*/
|
|
18990
|
+
createDate: string;
|
|
18991
|
+
/** @description ISO currency code. */
|
|
18992
|
+
currencyCode?: string;
|
|
18993
|
+
/**
|
|
18994
|
+
* Format: uuid
|
|
18995
|
+
* @description Refund id.
|
|
18996
|
+
*/
|
|
18997
|
+
id?: string;
|
|
18998
|
+
/** @description Refund initiator. */
|
|
18999
|
+
initiator?: string;
|
|
19000
|
+
/**
|
|
19001
|
+
* Format: uuid
|
|
19002
|
+
* @description Membership of the user who created the refund.
|
|
19003
|
+
*/
|
|
19004
|
+
membershipRefCreator?: string;
|
|
19005
|
+
/**
|
|
19006
|
+
* Format: uuid
|
|
19007
|
+
* @description Location id.
|
|
19008
|
+
*/
|
|
19009
|
+
organizationRef: string;
|
|
19010
|
+
/** @description User who created the refund. */
|
|
19011
|
+
userCreator?: {
|
|
19012
|
+
about?: string | null;
|
|
19013
|
+
email?: string | null;
|
|
19014
|
+
/** Format: uuid */
|
|
19015
|
+
id: string;
|
|
19016
|
+
name?: string | null;
|
|
19017
|
+
phoneNumber?: string | null;
|
|
19018
|
+
photoUrl?: string | null;
|
|
19019
|
+
surname?: string | null;
|
|
19020
|
+
};
|
|
19021
|
+
/**
|
|
19022
|
+
* Format: uuid
|
|
19023
|
+
* @description User id of the refund creator.
|
|
19024
|
+
*/
|
|
19025
|
+
userRefCreator?: string;
|
|
19026
|
+
}[];
|
|
19027
|
+
/**
|
|
19028
|
+
* @description Transaction status.
|
|
19029
|
+
* @enum {string}
|
|
19030
|
+
*/
|
|
19031
|
+
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
|
|
19032
|
+
/**
|
|
19033
|
+
* @deprecated
|
|
19034
|
+
* @description Deprecated. Use product instead.
|
|
19035
|
+
*/
|
|
19036
|
+
ticket?: {
|
|
19037
|
+
/**
|
|
19038
|
+
* Format: date-time
|
|
19039
|
+
* @description Ticket creation timestamp.
|
|
19040
|
+
*/
|
|
19041
|
+
createDate?: string;
|
|
19042
|
+
/**
|
|
19043
|
+
* Format: date-time
|
|
19044
|
+
* @description ISO timestamp of when the ticket was deleted.
|
|
19045
|
+
*/
|
|
19046
|
+
deleteDate?: string;
|
|
19047
|
+
/** @description Event details. */
|
|
19048
|
+
event?: {
|
|
19049
|
+
/**
|
|
19050
|
+
* Format: date-time
|
|
19051
|
+
* @description Event end date.
|
|
19052
|
+
*/
|
|
19053
|
+
endDate?: string;
|
|
19054
|
+
/**
|
|
19055
|
+
* Format: uuid
|
|
19056
|
+
* @description Event id.
|
|
19057
|
+
*/
|
|
19058
|
+
id: string;
|
|
19059
|
+
/**
|
|
19060
|
+
* Format: date-time
|
|
19061
|
+
* @description Event start date.
|
|
19062
|
+
*/
|
|
19063
|
+
startDate?: string;
|
|
19064
|
+
/** @description Event title. */
|
|
19065
|
+
title: string;
|
|
19066
|
+
};
|
|
19067
|
+
/**
|
|
19068
|
+
* Format: uuid
|
|
19069
|
+
* @description Ticket id.
|
|
19070
|
+
*/
|
|
19071
|
+
id: string;
|
|
19072
|
+
/**
|
|
19073
|
+
* Format: uuid
|
|
19074
|
+
* @description Membership of the user who deleted the ticket.
|
|
19075
|
+
*/
|
|
19076
|
+
membershipRefDeletedBy?: string;
|
|
19077
|
+
/**
|
|
19078
|
+
* @deprecated
|
|
19079
|
+
* @description Ticket price.
|
|
19080
|
+
*/
|
|
19081
|
+
price: {
|
|
19082
|
+
/** @description Amount excluding tax in major units. */
|
|
19083
|
+
netAmount: number;
|
|
19084
|
+
/** @description Tax amount in major units. */
|
|
19085
|
+
taxAmount?: number;
|
|
19086
|
+
};
|
|
19087
|
+
/** @description Number of tickets. */
|
|
19088
|
+
quantity: number;
|
|
19089
|
+
/** @description User who deleted the ticket. */
|
|
19090
|
+
userDeletedBy?: {
|
|
19091
|
+
about?: string | null;
|
|
19092
|
+
email?: string | null;
|
|
19093
|
+
/** Format: uuid */
|
|
19094
|
+
id: string;
|
|
19095
|
+
name?: string | null;
|
|
19096
|
+
phoneNumber?: string | null;
|
|
19097
|
+
photoUrl?: string | null;
|
|
19098
|
+
surname?: string | null;
|
|
19099
|
+
};
|
|
19100
|
+
};
|
|
19101
|
+
/**
|
|
19102
|
+
* @description Money transaction type.
|
|
19103
|
+
* @enum {string}
|
|
19104
|
+
*/
|
|
19105
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
19106
|
+
/**
|
|
19107
|
+
* @deprecated
|
|
19108
|
+
* @description Deprecated. Use customer.user instead.
|
|
19109
|
+
*/
|
|
19110
|
+
user?: {
|
|
19111
|
+
about?: string | null;
|
|
19112
|
+
email?: string | null;
|
|
19113
|
+
/** Format: uuid */
|
|
19114
|
+
id: string;
|
|
19115
|
+
name?: string | null;
|
|
19116
|
+
phoneNumber?: string | null;
|
|
19117
|
+
photoUrl?: string | null;
|
|
19118
|
+
surname?: string | null;
|
|
19119
|
+
};
|
|
19120
|
+
/** @description User who created the transaction. */
|
|
19121
|
+
userCreatedBy?: {
|
|
19122
|
+
about?: string | null;
|
|
19123
|
+
email?: string | null;
|
|
19124
|
+
/** Format: uuid */
|
|
19125
|
+
id: string;
|
|
19126
|
+
name?: string | null;
|
|
19127
|
+
phoneNumber?: string | null;
|
|
19128
|
+
photoUrl?: string | null;
|
|
19129
|
+
surname?: string | null;
|
|
19130
|
+
};
|
|
19131
|
+
/**
|
|
19132
|
+
* @deprecated
|
|
19133
|
+
* @description Deprecated. Use customer.user instead.
|
|
19134
|
+
*/
|
|
19135
|
+
userOwner?: {
|
|
19136
|
+
about?: string | null;
|
|
19137
|
+
email?: string | null;
|
|
19138
|
+
/** Format: uuid */
|
|
19139
|
+
id: string;
|
|
19140
|
+
name?: string | null;
|
|
19141
|
+
phoneNumber?: string | null;
|
|
19142
|
+
photoUrl?: string | null;
|
|
19143
|
+
surname?: string | null;
|
|
19144
|
+
};
|
|
19145
|
+
/**
|
|
19146
|
+
* Format: uuid
|
|
19147
|
+
* @deprecated
|
|
19148
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
19149
|
+
*/
|
|
19150
|
+
userRefCreator?: string;
|
|
19151
|
+
/**
|
|
19152
|
+
* Format: uuid
|
|
19153
|
+
* @deprecated
|
|
19154
|
+
* @description Deprecated. Use customer.user instead.
|
|
19155
|
+
*/
|
|
19156
|
+
userRefOwner?: string;
|
|
19157
|
+
}[];
|
|
19158
|
+
};
|
|
19159
|
+
createMoneyTransaction: {
|
|
19160
|
+
/** @description The created money transaction. */
|
|
19161
|
+
transaction: {
|
|
19162
|
+
/** @description Transaction amount in major units. */
|
|
19163
|
+
amount: number;
|
|
19164
|
+
/**
|
|
19165
|
+
* @deprecated
|
|
19166
|
+
* @description Deprecated. Use locationAddress instead.
|
|
19167
|
+
*/
|
|
19168
|
+
billingAddressBy?: string;
|
|
19169
|
+
/**
|
|
19170
|
+
* @deprecated
|
|
19171
|
+
* @description Deprecated. Use customerAddress instead.
|
|
19172
|
+
*/
|
|
19173
|
+
billingAddressTo?: string;
|
|
19174
|
+
/**
|
|
19175
|
+
* @deprecated
|
|
19176
|
+
* @description Deprecated. Use product instead.
|
|
19177
|
+
*/
|
|
19178
|
+
booking?: {
|
|
19179
|
+
/**
|
|
19180
|
+
* Format: date-time
|
|
19181
|
+
* @description ISO timestamp of when the booking was deleted.
|
|
19182
|
+
*/
|
|
19183
|
+
deleteDate?: string;
|
|
19184
|
+
/**
|
|
19185
|
+
* Format: date-time
|
|
19186
|
+
* @description Booking end date.
|
|
19187
|
+
*/
|
|
19188
|
+
endDate?: string;
|
|
19189
|
+
/**
|
|
19190
|
+
* Format: uuid
|
|
19191
|
+
* @description Booking id.
|
|
19192
|
+
*/
|
|
19193
|
+
id: string;
|
|
19194
|
+
/**
|
|
19195
|
+
* Format: uuid
|
|
19196
|
+
* @description Membership of the user who deleted the booking.
|
|
19197
|
+
*/
|
|
19198
|
+
membershipRefDeletedBy?: string;
|
|
19199
|
+
/**
|
|
19200
|
+
* @deprecated
|
|
19201
|
+
* @description Booking price.
|
|
19202
|
+
*/
|
|
19203
|
+
price: {
|
|
19204
|
+
/** @description Amount excluding tax in major units. */
|
|
19205
|
+
netAmount: number;
|
|
19206
|
+
/** @description Tax amount in major units. */
|
|
19207
|
+
taxAmount?: number;
|
|
19208
|
+
};
|
|
19209
|
+
/** @description Booked resource. */
|
|
19210
|
+
resource: {
|
|
19211
|
+
/**
|
|
19212
|
+
* Format: uuid
|
|
19213
|
+
* @description Resource id.
|
|
19214
|
+
*/
|
|
19215
|
+
id: string;
|
|
19216
|
+
/** @description Resource title. */
|
|
19217
|
+
title: string;
|
|
19218
|
+
};
|
|
19219
|
+
/**
|
|
19220
|
+
* Format: date-time
|
|
19221
|
+
* @description Booking start date.
|
|
19222
|
+
*/
|
|
19223
|
+
startDate?: string;
|
|
19224
|
+
/** @description User who deleted the booking. */
|
|
19225
|
+
userDeletedBy?: {
|
|
19226
|
+
about?: string | null;
|
|
19227
|
+
email?: string | null;
|
|
19228
|
+
/** Format: uuid */
|
|
19229
|
+
id: string;
|
|
19230
|
+
name?: string | null;
|
|
19231
|
+
phoneNumber?: string | null;
|
|
19232
|
+
photoUrl?: string | null;
|
|
19233
|
+
surname?: string | null;
|
|
19234
|
+
};
|
|
19235
|
+
};
|
|
19236
|
+
/**
|
|
19237
|
+
* @deprecated
|
|
19238
|
+
* @description Deprecated. Use customer instead.
|
|
19239
|
+
*/
|
|
19240
|
+
company?: {
|
|
19241
|
+
/**
|
|
19242
|
+
* Format: date-time
|
|
19243
|
+
* @description ISO timestamp of company creation.
|
|
19244
|
+
*/
|
|
19245
|
+
createDate: string;
|
|
19246
|
+
/**
|
|
19247
|
+
* Format: uuid
|
|
19248
|
+
* @description Company id.
|
|
19249
|
+
*/
|
|
19250
|
+
id: string;
|
|
19251
|
+
/**
|
|
19252
|
+
* Format: uuid
|
|
19253
|
+
* @description Location id.
|
|
19254
|
+
*/
|
|
19255
|
+
locationRef: string;
|
|
19256
|
+
/** @description Company metadata. */
|
|
19257
|
+
metadata?: {
|
|
19258
|
+
[key: string]: unknown;
|
|
19259
|
+
};
|
|
19260
|
+
/** @description Internal notes. */
|
|
19261
|
+
notes?: string;
|
|
19262
|
+
/**
|
|
19263
|
+
* Format: uuid
|
|
19264
|
+
* @description Primary subscription id.
|
|
19265
|
+
*/
|
|
19266
|
+
subscriptionRef: string | null;
|
|
19267
|
+
/** @description Company name. */
|
|
19268
|
+
title: string;
|
|
19269
|
+
};
|
|
19270
|
+
/**
|
|
19271
|
+
* Format: uuid
|
|
19272
|
+
* @deprecated
|
|
19273
|
+
* @description Deprecated. Use customer instead.
|
|
19274
|
+
*/
|
|
19275
|
+
companyRef?: string;
|
|
19276
|
+
/**
|
|
19277
|
+
* Format: date-time
|
|
19278
|
+
* @description ISO timestamp of when the transaction was created.
|
|
19279
|
+
*/
|
|
19280
|
+
createDate: string;
|
|
19281
|
+
/**
|
|
19282
|
+
* @deprecated
|
|
19283
|
+
* @description Deprecated. Use product instead.
|
|
19284
|
+
*/
|
|
19285
|
+
creditPackage?: {
|
|
19286
|
+
/** @description Credits amount of the package, or the package price when the package has no credits. */
|
|
19287
|
+
amount: number;
|
|
19288
|
+
/** @description Credits amount of the package. */
|
|
19289
|
+
creditsAmount?: number;
|
|
19290
|
+
/** @description Day passes amount of the package. */
|
|
19291
|
+
dayPassesAmount?: number;
|
|
19292
|
+
/**
|
|
19293
|
+
* @deprecated
|
|
19294
|
+
* @description Package price.
|
|
19295
|
+
*/
|
|
19296
|
+
price: {
|
|
19297
|
+
/** @description Amount excluding tax in major units. */
|
|
19298
|
+
netAmount: number;
|
|
19299
|
+
/** @description Tax amount in major units. */
|
|
19300
|
+
taxAmount?: number;
|
|
19301
|
+
};
|
|
19302
|
+
};
|
|
19303
|
+
/** @description ISO currency code. */
|
|
19304
|
+
currencyCode: string;
|
|
19305
|
+
/** @description Customer associated with this transaction. */
|
|
19306
|
+
customer?: {
|
|
19307
|
+
/**
|
|
19308
|
+
* Format: uuid
|
|
19309
|
+
* @description ID of the company or user.
|
|
19310
|
+
*/
|
|
19311
|
+
id: string;
|
|
19312
|
+
/** @description Company logo. */
|
|
19313
|
+
logo?: {
|
|
19314
|
+
key: string;
|
|
19315
|
+
url: string;
|
|
19316
|
+
};
|
|
19317
|
+
/** @description Public logo URL derived from the company website. */
|
|
19318
|
+
publicLogoUrl?: string;
|
|
19319
|
+
/** @description Company name. */
|
|
19320
|
+
title?: string;
|
|
19321
|
+
/**
|
|
19322
|
+
* @description Whether the customer is a company or a user.
|
|
19323
|
+
* @enum {string}
|
|
19324
|
+
*/
|
|
19325
|
+
type: "company" | "user";
|
|
19326
|
+
/** @description User details for user customers. */
|
|
19327
|
+
user?: {
|
|
19328
|
+
about?: string | null;
|
|
19329
|
+
email?: string | null;
|
|
19330
|
+
/** Format: uuid */
|
|
19331
|
+
id: string;
|
|
19332
|
+
name?: string | null;
|
|
19333
|
+
phoneNumber?: string | null;
|
|
19334
|
+
photoUrl?: string | null;
|
|
19335
|
+
surname?: string | null;
|
|
19336
|
+
};
|
|
19337
|
+
};
|
|
19338
|
+
/**
|
|
19339
|
+
* Format: uuid
|
|
19340
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
19341
|
+
*/
|
|
19342
|
+
customerRefCreatedBy?: string;
|
|
19343
|
+
/** @description Customer billing address. */
|
|
19344
|
+
customerAddress?: {
|
|
19345
|
+
city: string;
|
|
19346
|
+
countryCode: string | null;
|
|
19347
|
+
line1: string;
|
|
19348
|
+
line2: string;
|
|
19349
|
+
postalCode: string;
|
|
19350
|
+
state: string;
|
|
19351
|
+
};
|
|
19352
|
+
/** @description Customer legal name. */
|
|
19353
|
+
customerName?: string;
|
|
19354
|
+
/** @description Customer tax ID. */
|
|
19355
|
+
customerTaxId?: string;
|
|
19356
|
+
/** @description Custom item details. */
|
|
19357
|
+
customItem?: {
|
|
19358
|
+
/** @description Custom item currency code. */
|
|
19359
|
+
currencyCode?: string;
|
|
19360
|
+
/** @description Custom item description. */
|
|
19361
|
+
description?: string;
|
|
19362
|
+
tax?: {
|
|
19363
|
+
/** @description Whether tax is enabled for the custom item. */
|
|
19364
|
+
enabled: boolean;
|
|
19365
|
+
/** @description Tax rate. */
|
|
19366
|
+
rate: number;
|
|
19367
|
+
};
|
|
19368
|
+
/** @description Custom item unit amount in major units. */
|
|
19369
|
+
unitAmount?: number;
|
|
19370
|
+
/** @description Custom item unit quantity. */
|
|
19371
|
+
unitQuantity?: number;
|
|
19372
|
+
};
|
|
19373
|
+
/** @description Discounts applied to the transaction. */
|
|
19374
|
+
discounts?: {
|
|
19375
|
+
/** @description Applied coupon. */
|
|
19376
|
+
coupon: {
|
|
19377
|
+
/** @description Fixed amount discount. */
|
|
19378
|
+
amountOff?: number;
|
|
19379
|
+
/** @description Currency of the fixed amount discount. */
|
|
19380
|
+
currencyCode?: string;
|
|
19381
|
+
/** @description Coupon id. */
|
|
19382
|
+
id?: string;
|
|
19383
|
+
/** @description Percentage discount. */
|
|
19384
|
+
percentOff?: number;
|
|
19385
|
+
/** @description Product types the coupon applies to. */
|
|
19386
|
+
productTypes?: string[];
|
|
19387
|
+
/** @description Coupon type. */
|
|
19388
|
+
type?: string;
|
|
19389
|
+
};
|
|
19390
|
+
/** @description Promocode the coupon was applied with. */
|
|
19391
|
+
promocode?: {
|
|
19392
|
+
/** @description Promocode. */
|
|
19393
|
+
code: string;
|
|
19394
|
+
/** @description Promocode expiration settings. */
|
|
19395
|
+
expiration?: {
|
|
19396
|
+
/**
|
|
19397
|
+
* Format: date-time
|
|
19398
|
+
* @description ISO timestamp when the promocode expires.
|
|
19399
|
+
*/
|
|
19400
|
+
date?: string;
|
|
19401
|
+
/** @description Whether the promocode has an expiration date. */
|
|
19402
|
+
enabled: boolean;
|
|
19403
|
+
};
|
|
19404
|
+
/**
|
|
19405
|
+
* Format: uuid
|
|
19406
|
+
* @description Promocode id.
|
|
19407
|
+
*/
|
|
19408
|
+
id: string;
|
|
19409
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
19410
|
+
limitByFirstPurchase?: boolean;
|
|
19411
|
+
};
|
|
19412
|
+
/**
|
|
19413
|
+
* Format: uuid
|
|
19414
|
+
* @description ID of the subscription this discount is associated with.
|
|
19415
|
+
*/
|
|
19416
|
+
subscriptionId?: string;
|
|
19417
|
+
}[];
|
|
19418
|
+
/** @description Payment gateway error description for failed transactions. */
|
|
19419
|
+
errorDescription?: string;
|
|
19420
|
+
/**
|
|
19421
|
+
* Format: uuid
|
|
19422
|
+
* @description Unique identifier of the transaction.
|
|
19423
|
+
*/
|
|
19424
|
+
id: string;
|
|
19425
|
+
/**
|
|
19426
|
+
* @deprecated
|
|
19427
|
+
* @description Deprecated. Use product instead.
|
|
19428
|
+
*/
|
|
19429
|
+
invoice?: {
|
|
19430
|
+
/**
|
|
19431
|
+
* Format: uuid
|
|
19432
|
+
* @description Invoice id.
|
|
19433
|
+
*/
|
|
19434
|
+
id: string;
|
|
19435
|
+
/** @description Invoice title. */
|
|
19436
|
+
title: string;
|
|
19437
|
+
};
|
|
19438
|
+
/** @description Location billing address. */
|
|
19439
|
+
locationAddress?: {
|
|
19440
|
+
city: string;
|
|
19441
|
+
countryCode: string | null;
|
|
19442
|
+
line1: string;
|
|
19443
|
+
line2: string;
|
|
19444
|
+
postalCode: string;
|
|
19445
|
+
state: string;
|
|
19446
|
+
};
|
|
19447
|
+
/** @description Location legal name. */
|
|
19448
|
+
locationName?: string;
|
|
19449
|
+
/**
|
|
19450
|
+
* Format: uuid
|
|
19451
|
+
* @description ID of the organization (location).
|
|
19452
|
+
*/
|
|
19453
|
+
locationRef: string;
|
|
19454
|
+
/** @description Location tax ID. */
|
|
19455
|
+
locationTaxId?: string;
|
|
19456
|
+
/**
|
|
19457
|
+
* Format: uuid
|
|
19458
|
+
* @deprecated
|
|
19459
|
+
* @description Deprecated. Use customer instead.
|
|
19460
|
+
*/
|
|
19461
|
+
membershipRef?: string;
|
|
19462
|
+
/**
|
|
19463
|
+
* Format: uuid
|
|
19464
|
+
* @deprecated
|
|
19465
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
19466
|
+
*/
|
|
19467
|
+
membershipRefCreator?: string;
|
|
19468
|
+
/**
|
|
19469
|
+
* Format: uuid
|
|
19470
|
+
* @description ID of the network.
|
|
19471
|
+
*/
|
|
19472
|
+
networkRef: string;
|
|
19473
|
+
/**
|
|
19474
|
+
* @deprecated
|
|
19475
|
+
* @description Deprecated. Use product instead.
|
|
19476
|
+
*/
|
|
19477
|
+
order?: {
|
|
19478
|
+
/**
|
|
19479
|
+
* Format: uuid
|
|
19480
|
+
* @description Order id.
|
|
19481
|
+
*/
|
|
19482
|
+
id: string;
|
|
19483
|
+
/** @description Order items. */
|
|
19484
|
+
items: {
|
|
19485
|
+
/**
|
|
19486
|
+
* Format: uuid
|
|
19487
|
+
* @description Order item id.
|
|
19488
|
+
*/
|
|
19489
|
+
id: string;
|
|
19490
|
+
/** @description Ordered product. */
|
|
19491
|
+
product: {
|
|
19492
|
+
/**
|
|
19493
|
+
* Format: uuid
|
|
19494
|
+
* @description Product id.
|
|
19495
|
+
*/
|
|
19496
|
+
id: string;
|
|
19497
|
+
/** @description Product option. */
|
|
19498
|
+
option?: {
|
|
19499
|
+
/**
|
|
19500
|
+
* Format: uuid
|
|
19501
|
+
* @description Product option id.
|
|
19502
|
+
*/
|
|
19503
|
+
id: string;
|
|
19504
|
+
/** @description Product option title. */
|
|
19505
|
+
title: string;
|
|
19506
|
+
};
|
|
19507
|
+
/** @description Product title. */
|
|
19508
|
+
title: string;
|
|
19509
|
+
};
|
|
19510
|
+
/** @description Quantity of units. */
|
|
19511
|
+
quantity: number;
|
|
19512
|
+
}[];
|
|
19513
|
+
};
|
|
19514
|
+
/** @description Payment details. */
|
|
19515
|
+
payment: {
|
|
19516
|
+
/** @description Payment dispute details. */
|
|
19517
|
+
dispute?: {
|
|
19518
|
+
/**
|
|
19519
|
+
* Format: date-time
|
|
19520
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
19521
|
+
*/
|
|
19522
|
+
createDate: string;
|
|
19523
|
+
};
|
|
19524
|
+
/** @description Payment method used. */
|
|
19525
|
+
method: {
|
|
19526
|
+
/** @description Present when type is external. */
|
|
19527
|
+
external?: Record<string, never>;
|
|
19528
|
+
/** @description Present when type is paymentGateway. */
|
|
19529
|
+
paymentGateway?: {
|
|
19530
|
+
/** @description Payment gateway identifier. */
|
|
19531
|
+
gateway: string;
|
|
19532
|
+
/** @description Display label for the payment method. */
|
|
19533
|
+
label?: string;
|
|
19534
|
+
/** @description Masked card or account identifier. */
|
|
19535
|
+
mask?: string;
|
|
19536
|
+
/** @description Display title for the payment gateway. */
|
|
19537
|
+
title?: string;
|
|
19538
|
+
};
|
|
19539
|
+
/**
|
|
19540
|
+
* @description Payment method type.
|
|
19541
|
+
* @enum {string}
|
|
19542
|
+
*/
|
|
19543
|
+
type: "external" | "paymentGateway";
|
|
19544
|
+
};
|
|
19545
|
+
/** @description Payment price details. */
|
|
19546
|
+
price: {
|
|
19547
|
+
money: {
|
|
19548
|
+
/** @description ISO currency code. */
|
|
19549
|
+
currencyCode: string;
|
|
19550
|
+
/** @description Payment amount in major units. */
|
|
19551
|
+
grossAmount: number;
|
|
19552
|
+
};
|
|
19553
|
+
/** @enum {string} */
|
|
19554
|
+
type: "money";
|
|
19555
|
+
};
|
|
19556
|
+
/** @description Whether this payment can be refunded. */
|
|
19557
|
+
refundable: boolean;
|
|
19558
|
+
/** @description Refunds issued against this payment. */
|
|
19559
|
+
refunds?: {
|
|
19560
|
+
money: {
|
|
19561
|
+
/**
|
|
19562
|
+
* Format: date-time
|
|
19563
|
+
* @description Refund creation timestamp.
|
|
19564
|
+
*/
|
|
19565
|
+
createDate: string;
|
|
19566
|
+
/** @description ISO currency code. */
|
|
19567
|
+
currencyCode: string;
|
|
19568
|
+
/**
|
|
19569
|
+
* Format: uuid
|
|
19570
|
+
* @description ID of the customer the user who created the refund belongs to.
|
|
19571
|
+
*/
|
|
19572
|
+
customerRefCreatedBy?: string;
|
|
19573
|
+
/** @description Refunded amount in major units. */
|
|
19574
|
+
grossAmount: number;
|
|
19575
|
+
/**
|
|
19576
|
+
* Format: uuid
|
|
19577
|
+
* @description Refund id.
|
|
19578
|
+
*/
|
|
19579
|
+
id: string;
|
|
19580
|
+
/** @description Who initiated the refund: `spacebring` for a refund issued in Spacebring, `stripe` for one issued in the Stripe dashboard. */
|
|
19581
|
+
initiator?: string;
|
|
19582
|
+
/** @description User who created the refund. */
|
|
19583
|
+
userCreatedBy?: {
|
|
19584
|
+
about?: string | null;
|
|
19585
|
+
email?: string | null;
|
|
19586
|
+
/** Format: uuid */
|
|
19587
|
+
id: string;
|
|
19588
|
+
name?: string | null;
|
|
19589
|
+
phoneNumber?: string | null;
|
|
19590
|
+
photoUrl?: string | null;
|
|
19591
|
+
surname?: string | null;
|
|
19592
|
+
};
|
|
19593
|
+
}[];
|
|
19594
|
+
/** @enum {string} */
|
|
19595
|
+
type: "money";
|
|
19596
|
+
};
|
|
19597
|
+
/** @description Payment surcharge details. */
|
|
19598
|
+
surcharge?: {
|
|
19599
|
+
money: {
|
|
19600
|
+
/** @description Surcharge amount in major units. */
|
|
19601
|
+
amount: number;
|
|
19602
|
+
/** @description ISO currency code. */
|
|
19603
|
+
currencyCode: string;
|
|
19604
|
+
/** @description Surcharge percentage. */
|
|
19605
|
+
percentage?: number;
|
|
19606
|
+
/** @description Surcharge rate. */
|
|
19607
|
+
rate?: number;
|
|
19608
|
+
};
|
|
19609
|
+
/** @enum {string} */
|
|
19610
|
+
type: "money";
|
|
19611
|
+
};
|
|
19612
|
+
};
|
|
19613
|
+
/**
|
|
19614
|
+
* @deprecated
|
|
19615
|
+
* @description Deprecated. Use payment.method instead.
|
|
19616
|
+
*/
|
|
19617
|
+
paymentMethod: {
|
|
19618
|
+
/** @description Display label of the payment method. */
|
|
19619
|
+
label?: string;
|
|
19620
|
+
/** @description Payment gateway identifier, or external. */
|
|
19621
|
+
type: string;
|
|
19622
|
+
};
|
|
19623
|
+
/**
|
|
19624
|
+
* @deprecated
|
|
19625
|
+
* @description Deprecated. Use product instead.
|
|
19626
|
+
*/
|
|
19627
|
+
plan?: {
|
|
19628
|
+
/**
|
|
19629
|
+
* Format: uuid
|
|
19630
|
+
* @description Plan id.
|
|
19631
|
+
*/
|
|
19632
|
+
id: string;
|
|
19633
|
+
/** @description Plan title. */
|
|
19634
|
+
title: string;
|
|
19635
|
+
};
|
|
19636
|
+
/** @description Product details. */
|
|
19637
|
+
product?: {
|
|
19638
|
+
/**
|
|
19639
|
+
* Format: uuid
|
|
19640
|
+
* @description ID of the associated booking.
|
|
19641
|
+
*/
|
|
19642
|
+
bookingRef?: string;
|
|
19643
|
+
/**
|
|
19644
|
+
* Format: uuid
|
|
19645
|
+
* @description ID of the associated event ticket.
|
|
19646
|
+
*/
|
|
19647
|
+
eventTicketRef?: string;
|
|
19648
|
+
/**
|
|
19649
|
+
* Format: uuid
|
|
19650
|
+
* @description ID of the associated invoice.
|
|
19651
|
+
*/
|
|
19652
|
+
invoiceRef?: string;
|
|
19653
|
+
/**
|
|
19654
|
+
* Format: uuid
|
|
19655
|
+
* @description ID of the associated order.
|
|
19656
|
+
*/
|
|
19657
|
+
orderRef?: string;
|
|
19658
|
+
/**
|
|
19659
|
+
* Format: uuid
|
|
19660
|
+
* @description ID of the associated subscription.
|
|
19661
|
+
*/
|
|
19662
|
+
subscriptionRef?: string;
|
|
19663
|
+
/** @description Display title of the product. */
|
|
19664
|
+
title?: string;
|
|
19665
|
+
/**
|
|
19666
|
+
* @description Product type.
|
|
19667
|
+
* @enum {string}
|
|
19668
|
+
*/
|
|
19669
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
19670
|
+
};
|
|
19671
|
+
/** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
|
|
19672
|
+
receiptPdfUrl?: string;
|
|
19673
|
+
/**
|
|
19674
|
+
* @deprecated
|
|
19675
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
19676
|
+
*/
|
|
19677
|
+
refund?: {
|
|
19678
|
+
/** @description Refunded amount. */
|
|
19679
|
+
amount: number;
|
|
19680
|
+
/**
|
|
19681
|
+
* Format: date-time
|
|
19682
|
+
* @description Refund creation timestamp.
|
|
19683
|
+
*/
|
|
19684
|
+
createDate: string;
|
|
19685
|
+
};
|
|
19686
|
+
/**
|
|
19687
|
+
* @deprecated
|
|
19688
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
19689
|
+
*/
|
|
19690
|
+
refunds?: {
|
|
19691
|
+
/** @description Refunded amount. */
|
|
19692
|
+
amount: number;
|
|
19693
|
+
/**
|
|
19694
|
+
* Format: date-time
|
|
19695
|
+
* @description Refund creation timestamp.
|
|
19696
|
+
*/
|
|
19697
|
+
createDate: string;
|
|
19698
|
+
/** @description ISO currency code. */
|
|
19699
|
+
currencyCode?: string;
|
|
19700
|
+
/**
|
|
19701
|
+
* Format: uuid
|
|
19702
|
+
* @description Refund id.
|
|
19703
|
+
*/
|
|
19704
|
+
id?: string;
|
|
19705
|
+
/** @description Refund initiator. */
|
|
19706
|
+
initiator?: string;
|
|
19707
|
+
/**
|
|
19708
|
+
* Format: uuid
|
|
19709
|
+
* @description Membership of the user who created the refund.
|
|
19710
|
+
*/
|
|
19711
|
+
membershipRefCreator?: string;
|
|
19712
|
+
/**
|
|
19713
|
+
* Format: uuid
|
|
19714
|
+
* @description Location id.
|
|
19715
|
+
*/
|
|
19716
|
+
organizationRef: string;
|
|
19717
|
+
/** @description User who created the refund. */
|
|
19718
|
+
userCreator?: {
|
|
19719
|
+
about?: string | null;
|
|
19720
|
+
email?: string | null;
|
|
19721
|
+
/** Format: uuid */
|
|
19722
|
+
id: string;
|
|
19723
|
+
name?: string | null;
|
|
19724
|
+
phoneNumber?: string | null;
|
|
19725
|
+
photoUrl?: string | null;
|
|
19726
|
+
surname?: string | null;
|
|
19727
|
+
};
|
|
19728
|
+
/**
|
|
19729
|
+
* Format: uuid
|
|
19730
|
+
* @description User id of the refund creator.
|
|
19731
|
+
*/
|
|
19732
|
+
userRefCreator?: string;
|
|
19733
|
+
}[];
|
|
19734
|
+
/**
|
|
19735
|
+
* @description Transaction status.
|
|
19736
|
+
* @enum {string}
|
|
19737
|
+
*/
|
|
19738
|
+
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
|
|
19739
|
+
/**
|
|
19740
|
+
* @deprecated
|
|
19741
|
+
* @description Deprecated. Use product instead.
|
|
19742
|
+
*/
|
|
19743
|
+
ticket?: {
|
|
19744
|
+
/**
|
|
19745
|
+
* Format: date-time
|
|
19746
|
+
* @description Ticket creation timestamp.
|
|
19747
|
+
*/
|
|
19748
|
+
createDate?: string;
|
|
19749
|
+
/**
|
|
19750
|
+
* Format: date-time
|
|
19751
|
+
* @description ISO timestamp of when the ticket was deleted.
|
|
19752
|
+
*/
|
|
19753
|
+
deleteDate?: string;
|
|
19754
|
+
/** @description Event details. */
|
|
19755
|
+
event?: {
|
|
19756
|
+
/**
|
|
19757
|
+
* Format: date-time
|
|
19758
|
+
* @description Event end date.
|
|
19759
|
+
*/
|
|
19760
|
+
endDate?: string;
|
|
19761
|
+
/**
|
|
19762
|
+
* Format: uuid
|
|
19763
|
+
* @description Event id.
|
|
19764
|
+
*/
|
|
19765
|
+
id: string;
|
|
19766
|
+
/**
|
|
19767
|
+
* Format: date-time
|
|
19768
|
+
* @description Event start date.
|
|
19769
|
+
*/
|
|
19770
|
+
startDate?: string;
|
|
19771
|
+
/** @description Event title. */
|
|
19772
|
+
title: string;
|
|
19773
|
+
};
|
|
19774
|
+
/**
|
|
19775
|
+
* Format: uuid
|
|
19776
|
+
* @description Ticket id.
|
|
19777
|
+
*/
|
|
19778
|
+
id: string;
|
|
19779
|
+
/**
|
|
19780
|
+
* Format: uuid
|
|
19781
|
+
* @description Membership of the user who deleted the ticket.
|
|
19782
|
+
*/
|
|
19783
|
+
membershipRefDeletedBy?: string;
|
|
19784
|
+
/**
|
|
19785
|
+
* @deprecated
|
|
19786
|
+
* @description Ticket price.
|
|
19787
|
+
*/
|
|
19788
|
+
price: {
|
|
19789
|
+
/** @description Amount excluding tax in major units. */
|
|
19790
|
+
netAmount: number;
|
|
19791
|
+
/** @description Tax amount in major units. */
|
|
19792
|
+
taxAmount?: number;
|
|
19793
|
+
};
|
|
19794
|
+
/** @description Number of tickets. */
|
|
19795
|
+
quantity: number;
|
|
19796
|
+
/** @description User who deleted the ticket. */
|
|
19797
|
+
userDeletedBy?: {
|
|
19798
|
+
about?: string | null;
|
|
19799
|
+
email?: string | null;
|
|
19800
|
+
/** Format: uuid */
|
|
19801
|
+
id: string;
|
|
19802
|
+
name?: string | null;
|
|
19803
|
+
phoneNumber?: string | null;
|
|
19804
|
+
photoUrl?: string | null;
|
|
19805
|
+
surname?: string | null;
|
|
19806
|
+
};
|
|
19807
|
+
};
|
|
19808
|
+
/**
|
|
19809
|
+
* @description Money transaction type.
|
|
19810
|
+
* @enum {string}
|
|
19811
|
+
*/
|
|
19812
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
19813
|
+
/**
|
|
19814
|
+
* @deprecated
|
|
19815
|
+
* @description Deprecated. Use customer.user instead.
|
|
19816
|
+
*/
|
|
19817
|
+
user?: {
|
|
19818
|
+
about?: string | null;
|
|
19819
|
+
email?: string | null;
|
|
18272
19820
|
/** Format: uuid */
|
|
18273
|
-
id
|
|
18274
|
-
|
|
19821
|
+
id: string;
|
|
19822
|
+
name?: string | null;
|
|
19823
|
+
phoneNumber?: string | null;
|
|
19824
|
+
photoUrl?: string | null;
|
|
19825
|
+
surname?: string | null;
|
|
19826
|
+
};
|
|
19827
|
+
/** @description User who created the transaction. */
|
|
19828
|
+
userCreatedBy?: {
|
|
19829
|
+
about?: string | null;
|
|
19830
|
+
email?: string | null;
|
|
19831
|
+
/** Format: uuid */
|
|
19832
|
+
id: string;
|
|
19833
|
+
name?: string | null;
|
|
19834
|
+
phoneNumber?: string | null;
|
|
19835
|
+
photoUrl?: string | null;
|
|
19836
|
+
surname?: string | null;
|
|
19837
|
+
};
|
|
19838
|
+
/**
|
|
19839
|
+
* @deprecated
|
|
19840
|
+
* @description Deprecated. Use customer.user instead.
|
|
19841
|
+
*/
|
|
19842
|
+
userOwner?: {
|
|
19843
|
+
about?: string | null;
|
|
19844
|
+
email?: string | null;
|
|
19845
|
+
/** Format: uuid */
|
|
19846
|
+
id: string;
|
|
19847
|
+
name?: string | null;
|
|
19848
|
+
phoneNumber?: string | null;
|
|
19849
|
+
photoUrl?: string | null;
|
|
19850
|
+
surname?: string | null;
|
|
19851
|
+
};
|
|
19852
|
+
/**
|
|
19853
|
+
* Format: uuid
|
|
19854
|
+
* @deprecated
|
|
19855
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
19856
|
+
*/
|
|
19857
|
+
userRefCreator?: string;
|
|
19858
|
+
/**
|
|
19859
|
+
* Format: uuid
|
|
19860
|
+
* @deprecated
|
|
19861
|
+
* @description Deprecated. Use customer.user instead.
|
|
19862
|
+
*/
|
|
19863
|
+
userRefOwner?: string;
|
|
19864
|
+
};
|
|
19865
|
+
};
|
|
19866
|
+
getMoneyTransaction: {
|
|
19867
|
+
/** @description The money transaction. */
|
|
19868
|
+
transaction: {
|
|
19869
|
+
/** @description Transaction amount in major units. */
|
|
19870
|
+
amount: number;
|
|
19871
|
+
/**
|
|
19872
|
+
* @deprecated
|
|
19873
|
+
* @description Deprecated. Use locationAddress instead.
|
|
19874
|
+
*/
|
|
19875
|
+
billingAddressBy?: string;
|
|
19876
|
+
/**
|
|
19877
|
+
* @deprecated
|
|
19878
|
+
* @description Deprecated. Use customerAddress instead.
|
|
19879
|
+
*/
|
|
19880
|
+
billingAddressTo?: string;
|
|
19881
|
+
/**
|
|
19882
|
+
* @deprecated
|
|
19883
|
+
* @description Deprecated. Use product instead.
|
|
19884
|
+
*/
|
|
19885
|
+
booking?: {
|
|
19886
|
+
/**
|
|
19887
|
+
* Format: date-time
|
|
19888
|
+
* @description ISO timestamp of when the booking was deleted.
|
|
19889
|
+
*/
|
|
19890
|
+
deleteDate?: string;
|
|
19891
|
+
/**
|
|
19892
|
+
* Format: date-time
|
|
19893
|
+
* @description Booking end date.
|
|
19894
|
+
*/
|
|
19895
|
+
endDate?: string;
|
|
19896
|
+
/**
|
|
19897
|
+
* Format: uuid
|
|
19898
|
+
* @description Booking id.
|
|
19899
|
+
*/
|
|
19900
|
+
id: string;
|
|
19901
|
+
/**
|
|
19902
|
+
* Format: uuid
|
|
19903
|
+
* @description Membership of the user who deleted the booking.
|
|
19904
|
+
*/
|
|
19905
|
+
membershipRefDeletedBy?: string;
|
|
19906
|
+
/**
|
|
19907
|
+
* @deprecated
|
|
19908
|
+
* @description Booking price.
|
|
19909
|
+
*/
|
|
19910
|
+
price: {
|
|
19911
|
+
/** @description Amount excluding tax in major units. */
|
|
19912
|
+
netAmount: number;
|
|
19913
|
+
/** @description Tax amount in major units. */
|
|
19914
|
+
taxAmount?: number;
|
|
19915
|
+
};
|
|
19916
|
+
/** @description Booked resource. */
|
|
19917
|
+
resource: {
|
|
19918
|
+
/**
|
|
19919
|
+
* Format: uuid
|
|
19920
|
+
* @description Resource id.
|
|
19921
|
+
*/
|
|
19922
|
+
id: string;
|
|
19923
|
+
/** @description Resource title. */
|
|
19924
|
+
title: string;
|
|
19925
|
+
};
|
|
19926
|
+
/**
|
|
19927
|
+
* Format: date-time
|
|
19928
|
+
* @description Booking start date.
|
|
19929
|
+
*/
|
|
19930
|
+
startDate?: string;
|
|
19931
|
+
/** @description User who deleted the booking. */
|
|
19932
|
+
userDeletedBy?: {
|
|
19933
|
+
about?: string | null;
|
|
19934
|
+
email?: string | null;
|
|
19935
|
+
/** Format: uuid */
|
|
19936
|
+
id: string;
|
|
19937
|
+
name?: string | null;
|
|
19938
|
+
phoneNumber?: string | null;
|
|
19939
|
+
photoUrl?: string | null;
|
|
19940
|
+
surname?: string | null;
|
|
19941
|
+
};
|
|
19942
|
+
};
|
|
19943
|
+
/**
|
|
19944
|
+
* @deprecated
|
|
19945
|
+
* @description Deprecated. Use customer instead.
|
|
19946
|
+
*/
|
|
19947
|
+
company?: {
|
|
19948
|
+
/**
|
|
19949
|
+
* Format: date-time
|
|
19950
|
+
* @description ISO timestamp of company creation.
|
|
19951
|
+
*/
|
|
19952
|
+
createDate: string;
|
|
19953
|
+
/**
|
|
19954
|
+
* Format: uuid
|
|
19955
|
+
* @description Company id.
|
|
19956
|
+
*/
|
|
19957
|
+
id: string;
|
|
19958
|
+
/**
|
|
19959
|
+
* Format: uuid
|
|
19960
|
+
* @description Location id.
|
|
19961
|
+
*/
|
|
19962
|
+
locationRef: string;
|
|
19963
|
+
/** @description Company metadata. */
|
|
19964
|
+
metadata?: {
|
|
19965
|
+
[key: string]: unknown;
|
|
19966
|
+
};
|
|
19967
|
+
/** @description Internal notes. */
|
|
19968
|
+
notes?: string;
|
|
19969
|
+
/**
|
|
19970
|
+
* Format: uuid
|
|
19971
|
+
* @description Primary subscription id.
|
|
19972
|
+
*/
|
|
19973
|
+
subscriptionRef: string | null;
|
|
19974
|
+
/** @description Company name. */
|
|
19975
|
+
title: string;
|
|
19976
|
+
};
|
|
19977
|
+
/**
|
|
19978
|
+
* Format: uuid
|
|
19979
|
+
* @deprecated
|
|
19980
|
+
* @description Deprecated. Use customer instead.
|
|
19981
|
+
*/
|
|
19982
|
+
companyRef?: string;
|
|
19983
|
+
/**
|
|
19984
|
+
* Format: date-time
|
|
19985
|
+
* @description ISO timestamp of when the transaction was created.
|
|
19986
|
+
*/
|
|
19987
|
+
createDate: string;
|
|
19988
|
+
/**
|
|
19989
|
+
* @deprecated
|
|
19990
|
+
* @description Deprecated. Use product instead.
|
|
19991
|
+
*/
|
|
19992
|
+
creditPackage?: {
|
|
19993
|
+
/** @description Credits amount of the package, or the package price when the package has no credits. */
|
|
19994
|
+
amount: number;
|
|
19995
|
+
/** @description Credits amount of the package. */
|
|
19996
|
+
creditsAmount?: number;
|
|
19997
|
+
/** @description Day passes amount of the package. */
|
|
19998
|
+
dayPassesAmount?: number;
|
|
19999
|
+
/**
|
|
20000
|
+
* @deprecated
|
|
20001
|
+
* @description Package price.
|
|
20002
|
+
*/
|
|
20003
|
+
price: {
|
|
20004
|
+
/** @description Amount excluding tax in major units. */
|
|
20005
|
+
netAmount: number;
|
|
20006
|
+
/** @description Tax amount in major units. */
|
|
20007
|
+
taxAmount?: number;
|
|
20008
|
+
};
|
|
20009
|
+
};
|
|
20010
|
+
/** @description ISO currency code. */
|
|
20011
|
+
currencyCode: string;
|
|
20012
|
+
/** @description Customer associated with this transaction. */
|
|
20013
|
+
customer?: {
|
|
20014
|
+
/**
|
|
20015
|
+
* Format: uuid
|
|
20016
|
+
* @description ID of the company or user.
|
|
20017
|
+
*/
|
|
20018
|
+
id: string;
|
|
20019
|
+
/** @description Company logo. */
|
|
20020
|
+
logo?: {
|
|
20021
|
+
key: string;
|
|
20022
|
+
url: string;
|
|
20023
|
+
};
|
|
20024
|
+
/** @description Public logo URL derived from the company website. */
|
|
20025
|
+
publicLogoUrl?: string;
|
|
20026
|
+
/** @description Company name. */
|
|
20027
|
+
title?: string;
|
|
20028
|
+
/**
|
|
20029
|
+
* @description Whether the customer is a company or a user.
|
|
20030
|
+
* @enum {string}
|
|
20031
|
+
*/
|
|
20032
|
+
type: "company" | "user";
|
|
20033
|
+
/** @description User details for user customers. */
|
|
20034
|
+
user?: {
|
|
20035
|
+
about?: string | null;
|
|
20036
|
+
email?: string | null;
|
|
20037
|
+
/** Format: uuid */
|
|
20038
|
+
id: string;
|
|
20039
|
+
name?: string | null;
|
|
20040
|
+
phoneNumber?: string | null;
|
|
20041
|
+
photoUrl?: string | null;
|
|
20042
|
+
surname?: string | null;
|
|
20043
|
+
};
|
|
20044
|
+
};
|
|
20045
|
+
/**
|
|
20046
|
+
* Format: uuid
|
|
20047
|
+
* @description ID of the customer the user who created the transaction belongs to.
|
|
20048
|
+
*/
|
|
20049
|
+
customerRefCreatedBy?: string;
|
|
20050
|
+
/** @description Customer billing address. */
|
|
20051
|
+
customerAddress?: {
|
|
20052
|
+
city: string;
|
|
20053
|
+
countryCode: string | null;
|
|
20054
|
+
line1: string;
|
|
20055
|
+
line2: string;
|
|
20056
|
+
postalCode: string;
|
|
20057
|
+
state: string;
|
|
20058
|
+
};
|
|
20059
|
+
/** @description Customer legal name. */
|
|
20060
|
+
customerName?: string;
|
|
20061
|
+
/** @description Customer tax ID. */
|
|
20062
|
+
customerTaxId?: string;
|
|
20063
|
+
/** @description Custom item details. */
|
|
20064
|
+
customItem?: {
|
|
20065
|
+
/** @description Custom item currency code. */
|
|
20066
|
+
currencyCode?: string;
|
|
20067
|
+
/** @description Custom item description. */
|
|
20068
|
+
description?: string;
|
|
20069
|
+
tax?: {
|
|
20070
|
+
/** @description Whether tax is enabled for the custom item. */
|
|
20071
|
+
enabled: boolean;
|
|
20072
|
+
/** @description Tax rate. */
|
|
20073
|
+
rate: number;
|
|
20074
|
+
};
|
|
20075
|
+
/** @description Custom item unit amount in major units. */
|
|
20076
|
+
unitAmount?: number;
|
|
20077
|
+
/** @description Custom item unit quantity. */
|
|
20078
|
+
unitQuantity?: number;
|
|
20079
|
+
};
|
|
20080
|
+
/** @description Discounts applied to the transaction. */
|
|
20081
|
+
discounts?: {
|
|
20082
|
+
/** @description Applied coupon. */
|
|
20083
|
+
coupon: {
|
|
20084
|
+
/** @description Fixed amount discount. */
|
|
20085
|
+
amountOff?: number;
|
|
20086
|
+
/** @description Currency of the fixed amount discount. */
|
|
20087
|
+
currencyCode?: string;
|
|
20088
|
+
/** @description Coupon id. */
|
|
20089
|
+
id?: string;
|
|
20090
|
+
/** @description Percentage discount. */
|
|
20091
|
+
percentOff?: number;
|
|
20092
|
+
/** @description Product types the coupon applies to. */
|
|
20093
|
+
productTypes?: string[];
|
|
20094
|
+
/** @description Coupon type. */
|
|
20095
|
+
type?: string;
|
|
20096
|
+
};
|
|
20097
|
+
/** @description Promocode the coupon was applied with. */
|
|
20098
|
+
promocode?: {
|
|
20099
|
+
/** @description Promocode. */
|
|
20100
|
+
code: string;
|
|
20101
|
+
/** @description Promocode expiration settings. */
|
|
20102
|
+
expiration?: {
|
|
20103
|
+
/**
|
|
20104
|
+
* Format: date-time
|
|
20105
|
+
* @description ISO timestamp when the promocode expires.
|
|
20106
|
+
*/
|
|
20107
|
+
date?: string;
|
|
20108
|
+
/** @description Whether the promocode has an expiration date. */
|
|
20109
|
+
enabled: boolean;
|
|
20110
|
+
};
|
|
20111
|
+
/**
|
|
20112
|
+
* Format: uuid
|
|
20113
|
+
* @description Promocode id.
|
|
20114
|
+
*/
|
|
20115
|
+
id: string;
|
|
20116
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
20117
|
+
limitByFirstPurchase?: boolean;
|
|
20118
|
+
};
|
|
20119
|
+
/**
|
|
20120
|
+
* Format: uuid
|
|
20121
|
+
* @description ID of the subscription this discount is associated with.
|
|
20122
|
+
*/
|
|
20123
|
+
subscriptionId?: string;
|
|
20124
|
+
}[];
|
|
20125
|
+
/** @description Payment gateway error description for failed transactions. */
|
|
20126
|
+
errorDescription?: string;
|
|
20127
|
+
/**
|
|
20128
|
+
* Format: uuid
|
|
20129
|
+
* @description Unique identifier of the transaction.
|
|
20130
|
+
*/
|
|
20131
|
+
id: string;
|
|
20132
|
+
/**
|
|
20133
|
+
* @deprecated
|
|
20134
|
+
* @description Deprecated. Use product instead.
|
|
20135
|
+
*/
|
|
20136
|
+
invoice?: {
|
|
20137
|
+
/**
|
|
20138
|
+
* Format: uuid
|
|
20139
|
+
* @description Invoice id.
|
|
20140
|
+
*/
|
|
20141
|
+
id: string;
|
|
20142
|
+
/** @description Invoice title. */
|
|
20143
|
+
title: string;
|
|
20144
|
+
};
|
|
20145
|
+
/** @description Location billing address. */
|
|
20146
|
+
locationAddress?: {
|
|
20147
|
+
city: string;
|
|
20148
|
+
countryCode: string | null;
|
|
20149
|
+
line1: string;
|
|
20150
|
+
line2: string;
|
|
20151
|
+
postalCode: string;
|
|
20152
|
+
state: string;
|
|
20153
|
+
};
|
|
20154
|
+
/** @description Location legal name. */
|
|
20155
|
+
locationName?: string;
|
|
20156
|
+
/**
|
|
20157
|
+
* Format: uuid
|
|
20158
|
+
* @description ID of the organization (location).
|
|
20159
|
+
*/
|
|
20160
|
+
locationRef: string;
|
|
20161
|
+
/** @description Location tax ID. */
|
|
20162
|
+
locationTaxId?: string;
|
|
20163
|
+
/**
|
|
20164
|
+
* Format: uuid
|
|
20165
|
+
* @deprecated
|
|
20166
|
+
* @description Deprecated. Use customer instead.
|
|
20167
|
+
*/
|
|
20168
|
+
membershipRef?: string;
|
|
20169
|
+
/**
|
|
20170
|
+
* Format: uuid
|
|
20171
|
+
* @deprecated
|
|
20172
|
+
* @description Deprecated. Use customerRefCreatedBy instead.
|
|
20173
|
+
*/
|
|
20174
|
+
membershipRefCreator?: string;
|
|
20175
|
+
/**
|
|
20176
|
+
* Format: uuid
|
|
20177
|
+
* @description ID of the network.
|
|
20178
|
+
*/
|
|
20179
|
+
networkRef: string;
|
|
20180
|
+
/**
|
|
20181
|
+
* @deprecated
|
|
20182
|
+
* @description Deprecated. Use product instead.
|
|
20183
|
+
*/
|
|
20184
|
+
order?: {
|
|
20185
|
+
/**
|
|
20186
|
+
* Format: uuid
|
|
20187
|
+
* @description Order id.
|
|
20188
|
+
*/
|
|
20189
|
+
id: string;
|
|
20190
|
+
/** @description Order items. */
|
|
20191
|
+
items: {
|
|
20192
|
+
/**
|
|
20193
|
+
* Format: uuid
|
|
20194
|
+
* @description Order item id.
|
|
20195
|
+
*/
|
|
20196
|
+
id: string;
|
|
20197
|
+
/** @description Ordered product. */
|
|
20198
|
+
product: {
|
|
20199
|
+
/**
|
|
20200
|
+
* Format: uuid
|
|
20201
|
+
* @description Product id.
|
|
20202
|
+
*/
|
|
20203
|
+
id: string;
|
|
20204
|
+
/** @description Product option. */
|
|
20205
|
+
option?: {
|
|
20206
|
+
/**
|
|
20207
|
+
* Format: uuid
|
|
20208
|
+
* @description Product option id.
|
|
20209
|
+
*/
|
|
20210
|
+
id: string;
|
|
20211
|
+
/** @description Product option title. */
|
|
20212
|
+
title: string;
|
|
20213
|
+
};
|
|
20214
|
+
/** @description Product title. */
|
|
20215
|
+
title: string;
|
|
20216
|
+
};
|
|
20217
|
+
/** @description Quantity of units. */
|
|
20218
|
+
quantity: number;
|
|
20219
|
+
}[];
|
|
20220
|
+
};
|
|
20221
|
+
/** @description Payment details. */
|
|
20222
|
+
payment: {
|
|
20223
|
+
/** @description Payment dispute details. */
|
|
20224
|
+
dispute?: {
|
|
20225
|
+
/**
|
|
20226
|
+
* Format: date-time
|
|
20227
|
+
* @description ISO timestamp of when the dispute was opened.
|
|
20228
|
+
*/
|
|
20229
|
+
createDate: string;
|
|
20230
|
+
};
|
|
20231
|
+
/** @description Payment method used. */
|
|
20232
|
+
method: {
|
|
20233
|
+
/** @description Present when type is external. */
|
|
20234
|
+
external?: Record<string, never>;
|
|
20235
|
+
/** @description Present when type is paymentGateway. */
|
|
20236
|
+
paymentGateway?: {
|
|
20237
|
+
/** @description Payment gateway identifier. */
|
|
20238
|
+
gateway: string;
|
|
20239
|
+
/** @description Display label for the payment method. */
|
|
20240
|
+
label?: string;
|
|
20241
|
+
/** @description Masked card or account identifier. */
|
|
20242
|
+
mask?: string;
|
|
20243
|
+
/** @description Display title for the payment gateway. */
|
|
20244
|
+
title?: string;
|
|
20245
|
+
};
|
|
20246
|
+
/**
|
|
20247
|
+
* @description Payment method type.
|
|
20248
|
+
* @enum {string}
|
|
20249
|
+
*/
|
|
20250
|
+
type: "external" | "paymentGateway";
|
|
20251
|
+
};
|
|
20252
|
+
/** @description Payment price details. */
|
|
20253
|
+
price: {
|
|
20254
|
+
money: {
|
|
20255
|
+
/** @description ISO currency code. */
|
|
20256
|
+
currencyCode: string;
|
|
20257
|
+
/** @description Payment amount in major units. */
|
|
20258
|
+
grossAmount: number;
|
|
20259
|
+
};
|
|
20260
|
+
/** @enum {string} */
|
|
20261
|
+
type: "money";
|
|
20262
|
+
};
|
|
20263
|
+
/** @description Whether this payment can be refunded. */
|
|
20264
|
+
refundable: boolean;
|
|
20265
|
+
/** @description Refunds issued against this payment. */
|
|
20266
|
+
refunds?: {
|
|
20267
|
+
money: {
|
|
20268
|
+
/**
|
|
20269
|
+
* Format: date-time
|
|
20270
|
+
* @description Refund creation timestamp.
|
|
20271
|
+
*/
|
|
20272
|
+
createDate: string;
|
|
20273
|
+
/** @description ISO currency code. */
|
|
20274
|
+
currencyCode: string;
|
|
20275
|
+
/**
|
|
20276
|
+
* Format: uuid
|
|
20277
|
+
* @description ID of the customer the user who created the refund belongs to.
|
|
20278
|
+
*/
|
|
20279
|
+
customerRefCreatedBy?: string;
|
|
20280
|
+
/** @description Refunded amount in major units. */
|
|
20281
|
+
grossAmount: number;
|
|
20282
|
+
/**
|
|
20283
|
+
* Format: uuid
|
|
20284
|
+
* @description Refund id.
|
|
20285
|
+
*/
|
|
20286
|
+
id: string;
|
|
20287
|
+
/** @description Who initiated the refund: `spacebring` for a refund issued in Spacebring, `stripe` for one issued in the Stripe dashboard. */
|
|
20288
|
+
initiator?: string;
|
|
20289
|
+
/** @description User who created the refund. */
|
|
20290
|
+
userCreatedBy?: {
|
|
20291
|
+
about?: string | null;
|
|
20292
|
+
email?: string | null;
|
|
20293
|
+
/** Format: uuid */
|
|
20294
|
+
id: string;
|
|
20295
|
+
name?: string | null;
|
|
20296
|
+
phoneNumber?: string | null;
|
|
20297
|
+
photoUrl?: string | null;
|
|
20298
|
+
surname?: string | null;
|
|
20299
|
+
};
|
|
20300
|
+
}[];
|
|
20301
|
+
/** @enum {string} */
|
|
20302
|
+
type: "money";
|
|
20303
|
+
};
|
|
20304
|
+
/** @description Payment surcharge details. */
|
|
20305
|
+
surcharge?: {
|
|
20306
|
+
money: {
|
|
20307
|
+
/** @description Surcharge amount in major units. */
|
|
20308
|
+
amount: number;
|
|
20309
|
+
/** @description ISO currency code. */
|
|
20310
|
+
currencyCode: string;
|
|
20311
|
+
/** @description Surcharge percentage. */
|
|
20312
|
+
percentage?: number;
|
|
20313
|
+
/** @description Surcharge rate. */
|
|
20314
|
+
rate?: number;
|
|
20315
|
+
};
|
|
20316
|
+
/** @enum {string} */
|
|
20317
|
+
type: "money";
|
|
20318
|
+
};
|
|
20319
|
+
};
|
|
20320
|
+
/**
|
|
20321
|
+
* @deprecated
|
|
20322
|
+
* @description Deprecated. Use payment.method instead.
|
|
20323
|
+
*/
|
|
20324
|
+
paymentMethod: {
|
|
20325
|
+
/** @description Display label of the payment method. */
|
|
20326
|
+
label?: string;
|
|
20327
|
+
/** @description Payment gateway identifier, or external. */
|
|
20328
|
+
type: string;
|
|
20329
|
+
};
|
|
20330
|
+
/**
|
|
20331
|
+
* @deprecated
|
|
20332
|
+
* @description Deprecated. Use product instead.
|
|
20333
|
+
*/
|
|
20334
|
+
plan?: {
|
|
20335
|
+
/**
|
|
20336
|
+
* Format: uuid
|
|
20337
|
+
* @description Plan id.
|
|
20338
|
+
*/
|
|
20339
|
+
id: string;
|
|
20340
|
+
/** @description Plan title. */
|
|
20341
|
+
title: string;
|
|
20342
|
+
};
|
|
20343
|
+
/** @description Product details. */
|
|
20344
|
+
product?: {
|
|
20345
|
+
/**
|
|
20346
|
+
* Format: uuid
|
|
20347
|
+
* @description ID of the associated booking.
|
|
20348
|
+
*/
|
|
20349
|
+
bookingRef?: string;
|
|
20350
|
+
/**
|
|
20351
|
+
* Format: uuid
|
|
20352
|
+
* @description ID of the associated event ticket.
|
|
20353
|
+
*/
|
|
20354
|
+
eventTicketRef?: string;
|
|
20355
|
+
/**
|
|
20356
|
+
* Format: uuid
|
|
20357
|
+
* @description ID of the associated invoice.
|
|
20358
|
+
*/
|
|
20359
|
+
invoiceRef?: string;
|
|
20360
|
+
/**
|
|
20361
|
+
* Format: uuid
|
|
20362
|
+
* @description ID of the associated order.
|
|
20363
|
+
*/
|
|
20364
|
+
orderRef?: string;
|
|
20365
|
+
/**
|
|
20366
|
+
* Format: uuid
|
|
20367
|
+
* @description ID of the associated subscription.
|
|
20368
|
+
*/
|
|
20369
|
+
subscriptionRef?: string;
|
|
20370
|
+
/** @description Display title of the product. */
|
|
18275
20371
|
title?: string;
|
|
20372
|
+
/**
|
|
20373
|
+
* @description Product type.
|
|
20374
|
+
* @enum {string}
|
|
20375
|
+
*/
|
|
20376
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
20377
|
+
};
|
|
20378
|
+
/** @description URL to download the receipt PDF. The URL carries a receipt token, so it can be opened without authentication. */
|
|
20379
|
+
receiptPdfUrl?: string;
|
|
20380
|
+
/**
|
|
20381
|
+
* @deprecated
|
|
20382
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
20383
|
+
*/
|
|
20384
|
+
refund?: {
|
|
20385
|
+
/** @description Refunded amount. */
|
|
20386
|
+
amount: number;
|
|
20387
|
+
/**
|
|
20388
|
+
* Format: date-time
|
|
20389
|
+
* @description Refund creation timestamp.
|
|
20390
|
+
*/
|
|
20391
|
+
createDate: string;
|
|
20392
|
+
};
|
|
20393
|
+
/**
|
|
20394
|
+
* @deprecated
|
|
20395
|
+
* @description Deprecated. Use payment.refunds instead.
|
|
20396
|
+
*/
|
|
20397
|
+
refunds?: {
|
|
20398
|
+
/** @description Refunded amount. */
|
|
20399
|
+
amount: number;
|
|
20400
|
+
/**
|
|
20401
|
+
* Format: date-time
|
|
20402
|
+
* @description Refund creation timestamp.
|
|
20403
|
+
*/
|
|
20404
|
+
createDate: string;
|
|
20405
|
+
/** @description ISO currency code. */
|
|
20406
|
+
currencyCode?: string;
|
|
20407
|
+
/**
|
|
20408
|
+
* Format: uuid
|
|
20409
|
+
* @description Refund id.
|
|
20410
|
+
*/
|
|
20411
|
+
id?: string;
|
|
20412
|
+
/** @description Refund initiator. */
|
|
20413
|
+
initiator?: string;
|
|
20414
|
+
/**
|
|
20415
|
+
* Format: uuid
|
|
20416
|
+
* @description Membership of the user who created the refund.
|
|
20417
|
+
*/
|
|
20418
|
+
membershipRefCreator?: string;
|
|
20419
|
+
/**
|
|
20420
|
+
* Format: uuid
|
|
20421
|
+
* @description Location id.
|
|
20422
|
+
*/
|
|
20423
|
+
organizationRef: string;
|
|
20424
|
+
/** @description User who created the refund. */
|
|
20425
|
+
userCreator?: {
|
|
20426
|
+
about?: string | null;
|
|
20427
|
+
email?: string | null;
|
|
20428
|
+
/** Format: uuid */
|
|
20429
|
+
id: string;
|
|
20430
|
+
name?: string | null;
|
|
20431
|
+
phoneNumber?: string | null;
|
|
20432
|
+
photoUrl?: string | null;
|
|
20433
|
+
surname?: string | null;
|
|
20434
|
+
};
|
|
20435
|
+
/**
|
|
20436
|
+
* Format: uuid
|
|
20437
|
+
* @description User id of the refund creator.
|
|
20438
|
+
*/
|
|
20439
|
+
userRefCreator?: string;
|
|
20440
|
+
}[];
|
|
20441
|
+
/**
|
|
20442
|
+
* @description Transaction status.
|
|
20443
|
+
* @enum {string}
|
|
20444
|
+
*/
|
|
20445
|
+
status: "canceled" | "failed" | "pending" | "processing" | "succeeded";
|
|
20446
|
+
/**
|
|
20447
|
+
* @deprecated
|
|
20448
|
+
* @description Deprecated. Use product instead.
|
|
20449
|
+
*/
|
|
20450
|
+
ticket?: {
|
|
20451
|
+
/**
|
|
20452
|
+
* Format: date-time
|
|
20453
|
+
* @description Ticket creation timestamp.
|
|
20454
|
+
*/
|
|
20455
|
+
createDate?: string;
|
|
20456
|
+
/**
|
|
20457
|
+
* Format: date-time
|
|
20458
|
+
* @description ISO timestamp of when the ticket was deleted.
|
|
20459
|
+
*/
|
|
20460
|
+
deleteDate?: string;
|
|
20461
|
+
/** @description Event details. */
|
|
20462
|
+
event?: {
|
|
20463
|
+
/**
|
|
20464
|
+
* Format: date-time
|
|
20465
|
+
* @description Event end date.
|
|
20466
|
+
*/
|
|
20467
|
+
endDate?: string;
|
|
20468
|
+
/**
|
|
20469
|
+
* Format: uuid
|
|
20470
|
+
* @description Event id.
|
|
20471
|
+
*/
|
|
20472
|
+
id: string;
|
|
20473
|
+
/**
|
|
20474
|
+
* Format: date-time
|
|
20475
|
+
* @description Event start date.
|
|
20476
|
+
*/
|
|
20477
|
+
startDate?: string;
|
|
20478
|
+
/** @description Event title. */
|
|
20479
|
+
title: string;
|
|
20480
|
+
};
|
|
20481
|
+
/**
|
|
20482
|
+
* Format: uuid
|
|
20483
|
+
* @description Ticket id.
|
|
20484
|
+
*/
|
|
20485
|
+
id: string;
|
|
20486
|
+
/**
|
|
20487
|
+
* Format: uuid
|
|
20488
|
+
* @description Membership of the user who deleted the ticket.
|
|
20489
|
+
*/
|
|
20490
|
+
membershipRefDeletedBy?: string;
|
|
20491
|
+
/**
|
|
20492
|
+
* @deprecated
|
|
20493
|
+
* @description Ticket price.
|
|
20494
|
+
*/
|
|
20495
|
+
price: {
|
|
20496
|
+
/** @description Amount excluding tax in major units. */
|
|
20497
|
+
netAmount: number;
|
|
20498
|
+
/** @description Tax amount in major units. */
|
|
20499
|
+
taxAmount?: number;
|
|
20500
|
+
};
|
|
20501
|
+
/** @description Number of tickets. */
|
|
20502
|
+
quantity: number;
|
|
20503
|
+
/** @description User who deleted the ticket. */
|
|
20504
|
+
userDeletedBy?: {
|
|
20505
|
+
about?: string | null;
|
|
20506
|
+
email?: string | null;
|
|
20507
|
+
/** Format: uuid */
|
|
20508
|
+
id: string;
|
|
20509
|
+
name?: string | null;
|
|
20510
|
+
phoneNumber?: string | null;
|
|
20511
|
+
photoUrl?: string | null;
|
|
20512
|
+
surname?: string | null;
|
|
20513
|
+
};
|
|
20514
|
+
};
|
|
20515
|
+
/**
|
|
20516
|
+
* @description Money transaction type.
|
|
20517
|
+
* @enum {string}
|
|
20518
|
+
*/
|
|
20519
|
+
type: "booking" | "custom" | "creditPackage" | "eventTicket" | "invoice" | "order" | "subscription";
|
|
20520
|
+
/**
|
|
20521
|
+
* @deprecated
|
|
20522
|
+
* @description Deprecated. Use customer.user instead.
|
|
20523
|
+
*/
|
|
20524
|
+
user?: {
|
|
20525
|
+
about?: string | null;
|
|
20526
|
+
email?: string | null;
|
|
20527
|
+
/** Format: uuid */
|
|
20528
|
+
id: string;
|
|
20529
|
+
name?: string | null;
|
|
20530
|
+
phoneNumber?: string | null;
|
|
20531
|
+
photoUrl?: string | null;
|
|
20532
|
+
surname?: string | null;
|
|
20533
|
+
};
|
|
20534
|
+
/** @description User who created the transaction. */
|
|
20535
|
+
userCreatedBy?: {
|
|
20536
|
+
about?: string | null;
|
|
20537
|
+
email?: string | null;
|
|
20538
|
+
/** Format: uuid */
|
|
20539
|
+
id: string;
|
|
20540
|
+
name?: string | null;
|
|
20541
|
+
phoneNumber?: string | null;
|
|
20542
|
+
photoUrl?: string | null;
|
|
20543
|
+
surname?: string | null;
|
|
18276
20544
|
};
|
|
18277
|
-
|
|
18278
|
-
|
|
18279
|
-
|
|
20545
|
+
/**
|
|
20546
|
+
* @deprecated
|
|
20547
|
+
* @description Deprecated. Use customer.user instead.
|
|
20548
|
+
*/
|
|
20549
|
+
userOwner?: {
|
|
20550
|
+
about?: string | null;
|
|
20551
|
+
email?: string | null;
|
|
20552
|
+
/** Format: uuid */
|
|
20553
|
+
id: string;
|
|
20554
|
+
name?: string | null;
|
|
20555
|
+
phoneNumber?: string | null;
|
|
20556
|
+
photoUrl?: string | null;
|
|
20557
|
+
surname?: string | null;
|
|
18280
20558
|
};
|
|
20559
|
+
/**
|
|
20560
|
+
* Format: uuid
|
|
20561
|
+
* @deprecated
|
|
20562
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
20563
|
+
*/
|
|
20564
|
+
userRefCreator?: string;
|
|
20565
|
+
/**
|
|
20566
|
+
* Format: uuid
|
|
20567
|
+
* @deprecated
|
|
20568
|
+
* @description Deprecated. Use customer.user instead.
|
|
20569
|
+
*/
|
|
20570
|
+
userRefOwner?: string;
|
|
20571
|
+
};
|
|
20572
|
+
};
|
|
20573
|
+
refundMoneyTransaction: {
|
|
20574
|
+
/** @description The refund that was made. */
|
|
20575
|
+
refund: {
|
|
20576
|
+
/** @description Currency code of the refunded amount. */
|
|
20577
|
+
currencyCode: string;
|
|
20578
|
+
/** @description Refunded amount. */
|
|
20579
|
+
money: number;
|
|
18281
20580
|
};
|
|
18282
|
-
type?: string;
|
|
18283
|
-
user?: components["schemas"]["user"];
|
|
18284
20581
|
};
|
|
18285
20582
|
balance: {
|
|
18286
20583
|
allocation?: number;
|
|
@@ -19696,7 +21993,7 @@ interface components {
|
|
|
19696
21993
|
locationRef: string;
|
|
19697
21994
|
/** @description Media files attached to the event. */
|
|
19698
21995
|
media?: {
|
|
19699
|
-
/** @description Storage key of the media file. */
|
|
21996
|
+
/** @description Storage key of the media file, as returned by the media upload endpoint. */
|
|
19700
21997
|
key?: string;
|
|
19701
21998
|
/** @description Public URL of the media file. */
|
|
19702
21999
|
url?: string;
|
|
@@ -19791,7 +22088,7 @@ interface components {
|
|
|
19791
22088
|
locationRef: string;
|
|
19792
22089
|
/** @description Media files attached to the event. */
|
|
19793
22090
|
media?: {
|
|
19794
|
-
/** @description Storage key of the media file. */
|
|
22091
|
+
/** @description Storage key of the media file, as returned by the media upload endpoint. */
|
|
19795
22092
|
key?: string;
|
|
19796
22093
|
/** @description Public URL of the media file. */
|
|
19797
22094
|
url?: string;
|
|
@@ -19838,6 +22135,22 @@ interface components {
|
|
|
19838
22135
|
};
|
|
19839
22136
|
};
|
|
19840
22137
|
};
|
|
22138
|
+
createEventMedia: {
|
|
22139
|
+
content: {
|
|
22140
|
+
"application/json": {
|
|
22141
|
+
/** @description File to upload. */
|
|
22142
|
+
media: {
|
|
22143
|
+
/**
|
|
22144
|
+
* @description MIME type of the file to upload.
|
|
22145
|
+
* @enum {string}
|
|
22146
|
+
*/
|
|
22147
|
+
mimeType: "image/gif" | "image/jpeg" | "image/png" | "image/webp";
|
|
22148
|
+
/** @description Size of the file in bytes. The upload is rejected when the body length differs. */
|
|
22149
|
+
size: number;
|
|
22150
|
+
};
|
|
22151
|
+
};
|
|
22152
|
+
};
|
|
22153
|
+
};
|
|
19841
22154
|
createFeedPost: {
|
|
19842
22155
|
content: {
|
|
19843
22156
|
"application/json": {
|
|
@@ -20398,6 +22711,11 @@ interface components {
|
|
|
20398
22711
|
bookingPermission?: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
20399
22712
|
/** @description Booking step size in minutes. */
|
|
20400
22713
|
bookingStepMinutes?: number;
|
|
22714
|
+
/**
|
|
22715
|
+
* @description Whether bookings are measured in hours or in whole days. With day, bookings always cover the whole schedule of the day and the duration bounds are set to 24 hours. Defaults to hour.
|
|
22716
|
+
* @enum {string}
|
|
22717
|
+
*/
|
|
22718
|
+
bookingUnit?: "hour" | "day";
|
|
20401
22719
|
/** @description Brivo access group reference. */
|
|
20402
22720
|
brivoGroupRef?: number | null;
|
|
20403
22721
|
/**
|
|
@@ -20807,6 +23125,11 @@ interface components {
|
|
|
20807
23125
|
bookingPermission?: "admins" | "exclusiveMembers" | "members" | "networkMembers" | "public";
|
|
20808
23126
|
/** @description Booking step size in minutes. */
|
|
20809
23127
|
bookingStepMinutes?: number;
|
|
23128
|
+
/**
|
|
23129
|
+
* @description Whether bookings are measured in hours or in whole days. With day, bookings always cover the whole schedule of the day and the duration bounds are set to 24 hours. Defaults to hour.
|
|
23130
|
+
* @enum {string}
|
|
23131
|
+
*/
|
|
23132
|
+
bookingUnit?: "hour" | "day";
|
|
20810
23133
|
/** @description Brivo access group reference. */
|
|
20811
23134
|
brivoGroupRef?: number | null;
|
|
20812
23135
|
/**
|
|
@@ -21152,6 +23475,10 @@ interface components {
|
|
|
21152
23475
|
membershipRefOwner?: string;
|
|
21153
23476
|
/** @description Internal note attached to the booking. */
|
|
21154
23477
|
memo?: string;
|
|
23478
|
+
/** @description Key-value data attached to the booking. Values cannot be objects or arrays. Available only for admins. */
|
|
23479
|
+
metadata?: {
|
|
23480
|
+
[key: string]: unknown;
|
|
23481
|
+
};
|
|
21155
23482
|
/** @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
23483
|
recurrence?: string[];
|
|
21157
23484
|
/**
|
|
@@ -21162,18 +23489,50 @@ interface components {
|
|
|
21162
23489
|
/** @description Number of seats to reserve. Required for desk and office resources. */
|
|
21163
23490
|
seats?: number;
|
|
21164
23491
|
/**
|
|
21165
|
-
* @description Whether to notify the owner and the attendees about the booking. Defaults to `all`.
|
|
21166
|
-
* @default all
|
|
23492
|
+
* @description Whether to notify the owner and the attendees about the booking. Defaults to `all`.
|
|
23493
|
+
* @default all
|
|
23494
|
+
* @enum {string}
|
|
23495
|
+
*/
|
|
23496
|
+
sendUpdates?: "none" | "all";
|
|
23497
|
+
/**
|
|
23498
|
+
* Format: date-time
|
|
23499
|
+
* @description ISO timestamp when the booking starts.
|
|
23500
|
+
*/
|
|
23501
|
+
startDate: string;
|
|
23502
|
+
/** @description Custom title for the booking. */
|
|
23503
|
+
title?: string;
|
|
23504
|
+
};
|
|
23505
|
+
/** @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. */
|
|
23506
|
+
paymentMethod?: {
|
|
23507
|
+
/** @description Discounts to apply, echoed from the payment method. An empty array applies none; omitting it picks the best suited coupon. */
|
|
23508
|
+
discounts?: {
|
|
23509
|
+
/** @description Coupon to apply. */
|
|
23510
|
+
coupon?: {
|
|
23511
|
+
/**
|
|
23512
|
+
* Format: uuid
|
|
23513
|
+
* @description Unique identifier of the coupon.
|
|
23514
|
+
*/
|
|
23515
|
+
id: string;
|
|
23516
|
+
};
|
|
23517
|
+
/** @description Promocode that brought the coupon. */
|
|
23518
|
+
promocode?: {
|
|
23519
|
+
/** @description Promocode string. */
|
|
23520
|
+
code: string;
|
|
23521
|
+
};
|
|
23522
|
+
}[];
|
|
23523
|
+
/** @description External payment details: the payment is collected outside Spacebring, so it carries only its status. */
|
|
23524
|
+
external: {
|
|
23525
|
+
/**
|
|
23526
|
+
* @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.
|
|
23527
|
+
* @enum {string}
|
|
23528
|
+
*/
|
|
23529
|
+
status?: "pending" | "succeeded";
|
|
23530
|
+
};
|
|
23531
|
+
/**
|
|
23532
|
+
* @description Discriminator of the external payment method.
|
|
21167
23533
|
* @enum {string}
|
|
21168
23534
|
*/
|
|
21169
|
-
|
|
21170
|
-
/**
|
|
21171
|
-
* Format: date-time
|
|
21172
|
-
* @description ISO timestamp when the booking starts.
|
|
21173
|
-
*/
|
|
21174
|
-
startDate: string;
|
|
21175
|
-
/** @description Custom title for the booking. */
|
|
21176
|
-
title?: string;
|
|
23535
|
+
type: "external";
|
|
21177
23536
|
};
|
|
21178
23537
|
};
|
|
21179
23538
|
};
|
|
@@ -21202,6 +23561,12 @@ interface components {
|
|
|
21202
23561
|
entire?: boolean;
|
|
21203
23562
|
/** @description Internal note attached to the booking. */
|
|
21204
23563
|
memo?: string;
|
|
23564
|
+
/** @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. */
|
|
23565
|
+
metadata?: {
|
|
23566
|
+
[key: string]: unknown;
|
|
23567
|
+
};
|
|
23568
|
+
/** @description RRULE lines that replace how the booking repeats, e.g. `RRULE:FREQ=WEEKLY;COUNT=10`. The DTSTART line is derived from the booking start, and the occurrences already detached from the series stay excluded. Only supported for a repeating booking, and only with updateRepeatingScope set to `thisAndNext`. */
|
|
23569
|
+
recurrence?: string[];
|
|
21205
23570
|
/**
|
|
21206
23571
|
* Format: uuid
|
|
21207
23572
|
* @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 +24806,103 @@ interface components {
|
|
|
22441
24806
|
};
|
|
22442
24807
|
};
|
|
22443
24808
|
};
|
|
24809
|
+
createMoneyTransaction: {
|
|
24810
|
+
content: {
|
|
24811
|
+
"application/json": {
|
|
24812
|
+
/**
|
|
24813
|
+
* Format: uuid
|
|
24814
|
+
* @description ID of the company or user to charge.
|
|
24815
|
+
*/
|
|
24816
|
+
customerRef: string;
|
|
24817
|
+
/** @description Customer billing address. */
|
|
24818
|
+
customerAddress?: {
|
|
24819
|
+
/** @description City. */
|
|
24820
|
+
city?: string;
|
|
24821
|
+
/** @description ISO country code. */
|
|
24822
|
+
countryCode?: string | null;
|
|
24823
|
+
/** @description Address line 1. */
|
|
24824
|
+
line1?: string;
|
|
24825
|
+
/** @description Address line 2. */
|
|
24826
|
+
line2?: string;
|
|
24827
|
+
/** @description Postal code. */
|
|
24828
|
+
postalCode?: string;
|
|
24829
|
+
/** @description State or region. */
|
|
24830
|
+
state?: string;
|
|
24831
|
+
};
|
|
24832
|
+
/** @description Customer legal name. */
|
|
24833
|
+
customerName?: string;
|
|
24834
|
+
/** @description Customer tax ID. */
|
|
24835
|
+
customerTaxId?: string;
|
|
24836
|
+
/** @description Custom item to charge for. */
|
|
24837
|
+
customItem: {
|
|
24838
|
+
/** @description Custom item currency code. */
|
|
24839
|
+
currencyCode: string;
|
|
24840
|
+
/** @description Custom item description. */
|
|
24841
|
+
description?: string;
|
|
24842
|
+
/** @description Tax details. Required when the location has tax enabled. */
|
|
24843
|
+
tax?: {
|
|
24844
|
+
/** @description Tax rate. */
|
|
24845
|
+
rate: number;
|
|
24846
|
+
};
|
|
24847
|
+
/** @description Custom item unit amount in major units. */
|
|
24848
|
+
unitAmount: number;
|
|
24849
|
+
/** @description Custom item unit quantity. */
|
|
24850
|
+
unitQuantity: number;
|
|
24851
|
+
};
|
|
24852
|
+
/** @description Payment details. */
|
|
24853
|
+
payment: {
|
|
24854
|
+
/** @description Payment method details. */
|
|
24855
|
+
method: {
|
|
24856
|
+
/** @description External payment method, recorded outside the platform. */
|
|
24857
|
+
external?: Record<string, never>;
|
|
24858
|
+
/** @description Payment gateway (card) payment method. */
|
|
24859
|
+
paymentGateway?: {
|
|
24860
|
+
/**
|
|
24861
|
+
* @description Payment gateway provider. Only gateways that support saved payment methods can be charged.
|
|
24862
|
+
* @enum {string}
|
|
24863
|
+
*/
|
|
24864
|
+
gateway: "hyperpay" | "mollie" | "plata" | "stripe" | "tap" | "wayforpay";
|
|
24865
|
+
/**
|
|
24866
|
+
* Format: uuid
|
|
24867
|
+
* @description ID of the saved payment method to charge.
|
|
24868
|
+
*/
|
|
24869
|
+
id?: string | null;
|
|
24870
|
+
};
|
|
24871
|
+
/**
|
|
24872
|
+
* @description Selected payment method type.
|
|
24873
|
+
* @enum {string}
|
|
24874
|
+
*/
|
|
24875
|
+
type: "external" | "paymentGateway";
|
|
24876
|
+
};
|
|
24877
|
+
};
|
|
24878
|
+
};
|
|
24879
|
+
};
|
|
24880
|
+
};
|
|
24881
|
+
patchMoneyTransaction: {
|
|
24882
|
+
content: {
|
|
24883
|
+
"application/json": {
|
|
24884
|
+
/** @description Transaction fields to update. */
|
|
24885
|
+
transaction: {
|
|
24886
|
+
/**
|
|
24887
|
+
* @description New status of the pending external payment: `succeeded` approves it, `canceled` rejects it.
|
|
24888
|
+
* @enum {string}
|
|
24889
|
+
*/
|
|
24890
|
+
status: "canceled" | "succeeded";
|
|
24891
|
+
};
|
|
24892
|
+
};
|
|
24893
|
+
};
|
|
24894
|
+
};
|
|
24895
|
+
refundMoneyTransaction: {
|
|
24896
|
+
content: {
|
|
24897
|
+
"application/json": {
|
|
24898
|
+
/** @description Refund options for the transaction. */
|
|
24899
|
+
transaction?: {
|
|
24900
|
+
/** @description Amount to refund in major units. Defaults to the full refundable amount. */
|
|
24901
|
+
amount?: number;
|
|
24902
|
+
};
|
|
24903
|
+
};
|
|
24904
|
+
};
|
|
24905
|
+
};
|
|
22444
24906
|
createContact: {
|
|
22445
24907
|
content: {
|
|
22446
24908
|
"application/json": {
|
|
@@ -23823,6 +26285,8 @@ interface operations {
|
|
|
23823
26285
|
query?: {
|
|
23824
26286
|
/** @description The id of the company. */
|
|
23825
26287
|
companyRef?: string;
|
|
26288
|
+
/** @description The id of the customer. */
|
|
26289
|
+
customerRef?: string;
|
|
23826
26290
|
/** @description The id of the membership. */
|
|
23827
26291
|
membershipRef?: string;
|
|
23828
26292
|
};
|
|
@@ -25617,6 +28081,15 @@ interface operations {
|
|
|
25617
28081
|
"application/json": components["schemas"]["responseError"];
|
|
25618
28082
|
};
|
|
25619
28083
|
};
|
|
28084
|
+
/** @description Conflict */
|
|
28085
|
+
409: {
|
|
28086
|
+
headers: {
|
|
28087
|
+
[name: string]: unknown;
|
|
28088
|
+
};
|
|
28089
|
+
content: {
|
|
28090
|
+
"application/json": components["schemas"]["responseError"];
|
|
28091
|
+
};
|
|
28092
|
+
};
|
|
25620
28093
|
};
|
|
25621
28094
|
};
|
|
25622
28095
|
getEvent: {
|
|
@@ -25689,6 +28162,15 @@ interface operations {
|
|
|
25689
28162
|
"application/json": components["schemas"]["responseError"];
|
|
25690
28163
|
};
|
|
25691
28164
|
};
|
|
28165
|
+
/** @description Conflict */
|
|
28166
|
+
409: {
|
|
28167
|
+
headers: {
|
|
28168
|
+
[name: string]: unknown;
|
|
28169
|
+
};
|
|
28170
|
+
content: {
|
|
28171
|
+
"application/json": components["schemas"]["responseError"];
|
|
28172
|
+
};
|
|
28173
|
+
};
|
|
25692
28174
|
};
|
|
25693
28175
|
};
|
|
25694
28176
|
deleteEvent: {
|
|
@@ -25836,6 +28318,38 @@ interface operations {
|
|
|
25836
28318
|
};
|
|
25837
28319
|
};
|
|
25838
28320
|
};
|
|
28321
|
+
createEventMedia: {
|
|
28322
|
+
parameters: {
|
|
28323
|
+
query?: never;
|
|
28324
|
+
header?: {
|
|
28325
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
28326
|
+
"spacebring-network-id"?: string;
|
|
28327
|
+
};
|
|
28328
|
+
path?: never;
|
|
28329
|
+
cookie?: never;
|
|
28330
|
+
};
|
|
28331
|
+
requestBody: components["requestBodies"]["createEventMedia"];
|
|
28332
|
+
responses: {
|
|
28333
|
+
/** @description Created */
|
|
28334
|
+
201: {
|
|
28335
|
+
headers: {
|
|
28336
|
+
[name: string]: unknown;
|
|
28337
|
+
};
|
|
28338
|
+
content: {
|
|
28339
|
+
"application/json": components["schemas"]["createEventMedia"];
|
|
28340
|
+
};
|
|
28341
|
+
};
|
|
28342
|
+
/** @description Bad Request */
|
|
28343
|
+
400: {
|
|
28344
|
+
headers: {
|
|
28345
|
+
[name: string]: unknown;
|
|
28346
|
+
};
|
|
28347
|
+
content: {
|
|
28348
|
+
"application/json": components["schemas"]["responseError"];
|
|
28349
|
+
};
|
|
28350
|
+
};
|
|
28351
|
+
};
|
|
28352
|
+
};
|
|
25839
28353
|
getEventTickets: {
|
|
25840
28354
|
parameters: {
|
|
25841
28355
|
query?: {
|
|
@@ -27299,6 +29813,8 @@ interface operations {
|
|
|
27299
29813
|
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
27300
29814
|
nextPageToken?: string;
|
|
27301
29815
|
/** @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. */
|
|
29816
|
+
type?: string;
|
|
29817
|
+
/** @description Deprecated. Use type instead. */
|
|
27302
29818
|
types?: string;
|
|
27303
29819
|
};
|
|
27304
29820
|
header?: {
|
|
@@ -27625,7 +30141,9 @@ interface operations {
|
|
|
27625
30141
|
"startDate[lt]"?: string;
|
|
27626
30142
|
/** @description Matches bookings with startDate on or before this date (ISO 8601). */
|
|
27627
30143
|
"startDate[lte]"?: string;
|
|
27628
|
-
/** @description UUID of the
|
|
30144
|
+
/** @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. */
|
|
30145
|
+
companyRefOwner?: string;
|
|
30146
|
+
/** @description UUID of the customer whose bookings to list, both made and attended. */
|
|
27629
30147
|
customerRef?: string;
|
|
27630
30148
|
/** @description Deprecated. Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
27631
30149
|
endDate?: string;
|
|
@@ -27651,6 +30169,8 @@ interface operations {
|
|
|
27651
30169
|
status?: string;
|
|
27652
30170
|
/** @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
30171
|
type?: string;
|
|
30172
|
+
/** @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. */
|
|
30173
|
+
userRefOwner?: string;
|
|
27654
30174
|
/** @description Deprecated. Use type instead. */
|
|
27655
30175
|
types?: string;
|
|
27656
30176
|
};
|
|
@@ -29184,30 +31704,23 @@ interface operations {
|
|
|
29184
31704
|
};
|
|
29185
31705
|
getMoneyTransactions: {
|
|
29186
31706
|
parameters: {
|
|
29187
|
-
query
|
|
29188
|
-
/** @description
|
|
29189
|
-
|
|
29190
|
-
/** @description
|
|
31707
|
+
query?: {
|
|
31708
|
+
/** @description Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
31709
|
+
"createDate[gte]"?: string;
|
|
31710
|
+
/** @description Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
31711
|
+
"createDate[lte]"?: string;
|
|
31712
|
+
/** @description UUID of the company or user whose money transactions to list. */
|
|
31713
|
+
customerRef?: string;
|
|
31714
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
29191
31715
|
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
|
-
};
|
|
31716
|
+
/** @description UUID of the location whose money transactions to list. */
|
|
31717
|
+
locationRef?: string;
|
|
29209
31718
|
/** @description Token to retrieve the next page of results. */
|
|
29210
|
-
nextPageToken?:
|
|
31719
|
+
nextPageToken?: string;
|
|
31720
|
+
/** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
31721
|
+
status?: string;
|
|
31722
|
+
/** @description Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
|
|
31723
|
+
type?: string;
|
|
29211
31724
|
};
|
|
29212
31725
|
header?: {
|
|
29213
31726
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -29224,10 +31737,39 @@ interface operations {
|
|
|
29224
31737
|
[name: string]: unknown;
|
|
29225
31738
|
};
|
|
29226
31739
|
content: {
|
|
29227
|
-
"application/json":
|
|
29228
|
-
|
|
29229
|
-
|
|
29230
|
-
|
|
31740
|
+
"application/json": components["schemas"]["getMoneyTransactions"];
|
|
31741
|
+
};
|
|
31742
|
+
};
|
|
31743
|
+
/** @description Bad Request */
|
|
31744
|
+
400: {
|
|
31745
|
+
headers: {
|
|
31746
|
+
[name: string]: unknown;
|
|
31747
|
+
};
|
|
31748
|
+
content: {
|
|
31749
|
+
"application/json": components["schemas"]["responseError"];
|
|
31750
|
+
};
|
|
31751
|
+
};
|
|
31752
|
+
};
|
|
31753
|
+
};
|
|
31754
|
+
createMoneyTransaction: {
|
|
31755
|
+
parameters: {
|
|
31756
|
+
query?: never;
|
|
31757
|
+
header?: {
|
|
31758
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31759
|
+
"spacebring-network-id"?: string;
|
|
31760
|
+
};
|
|
31761
|
+
path?: never;
|
|
31762
|
+
cookie?: never;
|
|
31763
|
+
};
|
|
31764
|
+
requestBody: components["requestBodies"]["createMoneyTransaction"];
|
|
31765
|
+
responses: {
|
|
31766
|
+
/** @description Created */
|
|
31767
|
+
201: {
|
|
31768
|
+
headers: {
|
|
31769
|
+
[name: string]: unknown;
|
|
31770
|
+
};
|
|
31771
|
+
content: {
|
|
31772
|
+
"application/json": components["schemas"]["createMoneyTransaction"];
|
|
29231
31773
|
};
|
|
29232
31774
|
};
|
|
29233
31775
|
/** @description Bad Request */
|
|
@@ -29249,8 +31791,8 @@ interface operations {
|
|
|
29249
31791
|
"spacebring-network-id"?: string;
|
|
29250
31792
|
};
|
|
29251
31793
|
path: {
|
|
29252
|
-
/** @description The id of the transaction */
|
|
29253
|
-
|
|
31794
|
+
/** @description The id of the transaction. */
|
|
31795
|
+
transactionId: string;
|
|
29254
31796
|
};
|
|
29255
31797
|
cookie?: never;
|
|
29256
31798
|
};
|
|
@@ -29262,9 +31804,75 @@ interface operations {
|
|
|
29262
31804
|
[name: string]: unknown;
|
|
29263
31805
|
};
|
|
29264
31806
|
content: {
|
|
29265
|
-
"application/json":
|
|
29266
|
-
|
|
29267
|
-
|
|
31807
|
+
"application/json": components["schemas"]["getMoneyTransaction"];
|
|
31808
|
+
};
|
|
31809
|
+
};
|
|
31810
|
+
/** @description Bad Request */
|
|
31811
|
+
400: {
|
|
31812
|
+
headers: {
|
|
31813
|
+
[name: string]: unknown;
|
|
31814
|
+
};
|
|
31815
|
+
content: {
|
|
31816
|
+
"application/json": components["schemas"]["responseError"];
|
|
31817
|
+
};
|
|
31818
|
+
};
|
|
31819
|
+
};
|
|
31820
|
+
};
|
|
31821
|
+
patchMoneyTransaction: {
|
|
31822
|
+
parameters: {
|
|
31823
|
+
query?: never;
|
|
31824
|
+
header?: {
|
|
31825
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31826
|
+
"spacebring-network-id"?: string;
|
|
31827
|
+
};
|
|
31828
|
+
path: {
|
|
31829
|
+
/** @description The id of the transaction. */
|
|
31830
|
+
transactionId: string;
|
|
31831
|
+
};
|
|
31832
|
+
cookie?: never;
|
|
31833
|
+
};
|
|
31834
|
+
requestBody: components["requestBodies"]["patchMoneyTransaction"];
|
|
31835
|
+
responses: {
|
|
31836
|
+
/** @description No Content */
|
|
31837
|
+
204: {
|
|
31838
|
+
headers: {
|
|
31839
|
+
[name: string]: unknown;
|
|
31840
|
+
};
|
|
31841
|
+
content?: never;
|
|
31842
|
+
};
|
|
31843
|
+
/** @description Bad Request */
|
|
31844
|
+
400: {
|
|
31845
|
+
headers: {
|
|
31846
|
+
[name: string]: unknown;
|
|
31847
|
+
};
|
|
31848
|
+
content: {
|
|
31849
|
+
"application/json": components["schemas"]["responseError"];
|
|
31850
|
+
};
|
|
31851
|
+
};
|
|
31852
|
+
};
|
|
31853
|
+
};
|
|
31854
|
+
refundMoneyTransaction: {
|
|
31855
|
+
parameters: {
|
|
31856
|
+
query?: never;
|
|
31857
|
+
header?: {
|
|
31858
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
31859
|
+
"spacebring-network-id"?: string;
|
|
31860
|
+
};
|
|
31861
|
+
path: {
|
|
31862
|
+
/** @description The id of the transaction. */
|
|
31863
|
+
transactionId: string;
|
|
31864
|
+
};
|
|
31865
|
+
cookie?: never;
|
|
31866
|
+
};
|
|
31867
|
+
requestBody?: components["requestBodies"]["refundMoneyTransaction"];
|
|
31868
|
+
responses: {
|
|
31869
|
+
/** @description OK */
|
|
31870
|
+
200: {
|
|
31871
|
+
headers: {
|
|
31872
|
+
[name: string]: unknown;
|
|
31873
|
+
};
|
|
31874
|
+
content: {
|
|
31875
|
+
"application/json": components["schemas"]["refundMoneyTransaction"];
|
|
29268
31876
|
};
|
|
29269
31877
|
};
|
|
29270
31878
|
/** @description Bad Request */
|
|
@@ -30031,7 +32639,9 @@ type DayPassScheduledTransaction = NonNullable<operations["getScheduledDayPasses
|
|
|
30031
32639
|
/** A DayPassTransaction entity as returned by the Spacebring API. */
|
|
30032
32640
|
type DayPassTransaction = NonNullable<components["schemas"]["transactionDayPasses"]>;
|
|
30033
32641
|
/** A MoneyTransaction entity as returned by the Spacebring API. */
|
|
30034
|
-
type MoneyTransaction = NonNullable<
|
|
32642
|
+
type MoneyTransaction = NonNullable<operations["getMoneyTransaction"]["responses"][200]["content"]["application/json"]["transaction"]>;
|
|
32643
|
+
/** A Refund entity as returned by the Spacebring API. */
|
|
32644
|
+
type Refund = NonNullable<operations["refundMoneyTransaction"]["responses"][200]["content"]["application/json"]["refund"]>;
|
|
30035
32645
|
/** Query parameters for `sb.transactions.credits.list()`. */
|
|
30036
32646
|
interface GetCreditsTransactionsQuery {
|
|
30037
32647
|
/** @deprecated Use customerRef instead. The id of the company to get transactions for. */
|
|
@@ -30078,21 +32688,22 @@ interface GetDayPassesTransactionsQuery {
|
|
|
30078
32688
|
}
|
|
30079
32689
|
/** Query parameters for `sb.transactions.money.list()`. */
|
|
30080
32690
|
interface GetMoneyTransactionsQuery {
|
|
30081
|
-
/**
|
|
30082
|
-
|
|
30083
|
-
/**
|
|
32691
|
+
/** Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
32692
|
+
"createDate[gte]"?: string;
|
|
32693
|
+
/** Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
32694
|
+
"createDate[lte]"?: string;
|
|
32695
|
+
/** UUID of the company or user whose money transactions to list. */
|
|
32696
|
+
customerRef?: string;
|
|
32697
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
30084
32698
|
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
|
-
};
|
|
32699
|
+
/** UUID of the location whose money transactions to list. */
|
|
32700
|
+
locationRef?: string;
|
|
30094
32701
|
/** Token to retrieve the next page of results. */
|
|
30095
32702
|
nextPageToken?: string;
|
|
32703
|
+
/** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
32704
|
+
status?: string;
|
|
32705
|
+
/** Filter by transaction type. Comma-separated type values, e.g. `type=booking,invoice`. */
|
|
32706
|
+
type?: string;
|
|
30096
32707
|
}
|
|
30097
32708
|
/** Query parameters for `sb.transactions.credits.scheduled.list()`. */
|
|
30098
32709
|
interface GetScheduledCreditsTransactionsQuery {
|
|
@@ -30120,6 +32731,12 @@ interface GetScheduledDayPassesTransactionsQuery {
|
|
|
30120
32731
|
type CreateCreditsTransactionBody = NonNullable<NonNullable<operations["createCreditsTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
30121
32732
|
/** Request body for `sb.transactions.dayPasses.create()`. */
|
|
30122
32733
|
type CreateDayPassesTransactionBody = NonNullable<NonNullable<operations["createDayPassesTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
32734
|
+
/** Request body for `sb.transactions.money.create()`. */
|
|
32735
|
+
type CreateMoneyTransactionBody = NonNullable<operations["createMoneyTransaction"]["requestBody"]>["content"]["application/json"];
|
|
32736
|
+
/** Request body for `sb.transactions.money.update()`. */
|
|
32737
|
+
type PatchMoneyTransactionBody = NonNullable<NonNullable<operations["patchMoneyTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
32738
|
+
/** Request body for `sb.transactions.money.refund()`. */
|
|
32739
|
+
type RefundMoneyTransactionBody = NonNullable<NonNullable<operations["refundMoneyTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
30123
32740
|
|
|
30124
32741
|
/** A Activity entity as returned by the Spacebring API. */
|
|
30125
32742
|
type Activity = NonNullable<components["schemas"]["ticketActivity"]>;
|
|
@@ -30285,7 +32902,9 @@ interface GetBookingsQuery {
|
|
|
30285
32902
|
"startDate[lt]"?: string;
|
|
30286
32903
|
/** Matches bookings with startDate on or before this date (ISO 8601). */
|
|
30287
32904
|
"startDate[lte]"?: string;
|
|
30288
|
-
/** UUID of the
|
|
32905
|
+
/** 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. */
|
|
32906
|
+
companyRefOwner?: string;
|
|
32907
|
+
/** UUID of the customer whose bookings to list, both made and attended. */
|
|
30289
32908
|
customerRef?: string;
|
|
30290
32909
|
/** @deprecated Use bracket-notation fields endDate[gt], endDate[gte], endDate[lt], endDate[lte] instead. */
|
|
30291
32910
|
endDate?: string;
|
|
@@ -30311,6 +32930,8 @@ interface GetBookingsQuery {
|
|
|
30311
32930
|
status?: string;
|
|
30312
32931
|
/** 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
32932
|
type?: string;
|
|
32933
|
+
/** 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. */
|
|
32934
|
+
userRefOwner?: string;
|
|
30314
32935
|
/** @deprecated Use type instead. */
|
|
30315
32936
|
types?: string;
|
|
30316
32937
|
}
|
|
@@ -30323,12 +32944,14 @@ interface GetResourcesQuery {
|
|
|
30323
32944
|
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
30324
32945
|
nextPageToken?: string;
|
|
30325
32946
|
/** 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. */
|
|
32947
|
+
type?: string;
|
|
32948
|
+
/** @deprecated Use type instead. */
|
|
30326
32949
|
types?: string;
|
|
30327
32950
|
}
|
|
30328
32951
|
/** Request body for `sb.resources.assignments.create()`. */
|
|
30329
32952
|
type CreateAssignmentBody = NonNullable<NonNullable<operations["createAssignment"]["requestBody"]>["content"]["application/json"]["assignment"]>;
|
|
30330
32953
|
/** Request body for `sb.resources.bookings.create()`. */
|
|
30331
|
-
type CreateBookingBody = NonNullable<
|
|
32954
|
+
type CreateBookingBody = NonNullable<operations["createBooking"]["requestBody"]>["content"]["application/json"];
|
|
30332
32955
|
/** Request body for `sb.resources.create()`. */
|
|
30333
32956
|
type CreateResourceBody = NonNullable<NonNullable<operations["createResource"]["requestBody"]>["content"]["application/json"]["resource"]>;
|
|
30334
32957
|
/** Request body for `sb.resources.assignments.update()`. */
|
|
@@ -30442,6 +33065,8 @@ type UpdateFeedPostBody = NonNullable<NonNullable<operations["updateFeedPost"]["
|
|
|
30442
33065
|
type Event = NonNullable<components["schemas"]["event"]>;
|
|
30443
33066
|
/** A EventTicket entity as returned by the Spacebring API. */
|
|
30444
33067
|
type EventTicket = NonNullable<components["schemas"]["eventTicket"]>;
|
|
33068
|
+
/** A Media entity as returned by the Spacebring API. */
|
|
33069
|
+
type Media = NonNullable<operations["createEventMedia"]["responses"][201]["content"]["application/json"]["media"]>;
|
|
30445
33070
|
/** Query parameters for `sb.events.list()`. */
|
|
30446
33071
|
interface GetEventsByOrganizationQuery {
|
|
30447
33072
|
/** The id of the location. */
|
|
@@ -30480,6 +33105,8 @@ interface GetEventTicketsQuery {
|
|
|
30480
33105
|
type AddEventHostsBody = NonNullable<NonNullable<operations["addEventHosts"]["requestBody"]>["content"]["application/json"]["tickets"]>;
|
|
30481
33106
|
/** Request body for `sb.events.create()`. */
|
|
30482
33107
|
type CreateEventBody = NonNullable<NonNullable<operations["createEvent"]["requestBody"]>["content"]["application/json"]["event"]>;
|
|
33108
|
+
/** Request body for `sb.events.createMedia()`. */
|
|
33109
|
+
type CreateEventMediaBody = NonNullable<NonNullable<operations["createEventMedia"]["requestBody"]>["content"]["application/json"]["media"]>;
|
|
30483
33110
|
/** Request body for `sb.events.update()`. */
|
|
30484
33111
|
type UpdateEventBody = NonNullable<NonNullable<operations["updateEvent"]["requestBody"]>["content"]["application/json"]["event"]>;
|
|
30485
33112
|
/** Request body for `sb.events.tickets.update()`. */
|
|
@@ -30703,6 +33330,8 @@ interface GetInvoicesQuery {
|
|
|
30703
33330
|
interface GetUpcomingInvoiceItemsQuery {
|
|
30704
33331
|
/** The id of the company. */
|
|
30705
33332
|
companyRef?: string;
|
|
33333
|
+
/** The id of the customer. */
|
|
33334
|
+
customerRef?: string;
|
|
30706
33335
|
/** The id of the membership. */
|
|
30707
33336
|
membershipRef?: string;
|
|
30708
33337
|
}
|
|
@@ -31026,6 +33655,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
31026
33655
|
addEventHosts(id: string, tickets: AddEventHostsBody, options?: SpacebringRequestOptions): Promise<EventTicket[]>;
|
|
31027
33656
|
cancel(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
31028
33657
|
copy(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
33658
|
+
createMedia(media: CreateEventMediaBody, options?: SpacebringRequestOptions): Promise<Media>;
|
|
31029
33659
|
tickets: {
|
|
31030
33660
|
list(query?: GetEventTicketsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
31031
33661
|
tickets?: EventTicket[];
|
|
@@ -31145,7 +33775,7 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
31145
33775
|
}>;
|
|
31146
33776
|
iterate(query?: Omit<GetBookingsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<Booking, void, undefined>;
|
|
31147
33777
|
get(bookingId: string, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
31148
|
-
create(
|
|
33778
|
+
create(body: CreateBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
31149
33779
|
update(bookingId: string, body: PatchBookingBody, options?: SpacebringRequestOptions): Promise<Booking>;
|
|
31150
33780
|
delete(bookingId: string, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
31151
33781
|
};
|
|
@@ -31268,12 +33898,16 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
31268
33898
|
};
|
|
31269
33899
|
};
|
|
31270
33900
|
money: {
|
|
31271
|
-
list(query
|
|
31272
|
-
transactions?: MoneyTransaction[];
|
|
33901
|
+
list(query?: GetMoneyTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
31273
33902
|
nextPageToken?: string;
|
|
33903
|
+
searchQueryNext?: string;
|
|
33904
|
+
transactions: MoneyTransaction[];
|
|
31274
33905
|
}>;
|
|
31275
|
-
iterate(query
|
|
31276
|
-
get(
|
|
33906
|
+
iterate(query?: Omit<GetMoneyTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<MoneyTransaction, void, undefined>;
|
|
33907
|
+
get(transactionId: string, options?: SpacebringRequestOptions): Promise<MoneyTransaction>;
|
|
33908
|
+
create(body: CreateMoneyTransactionBody, options?: SpacebringRequestOptions): Promise<MoneyTransaction>;
|
|
33909
|
+
update(transactionId: string, transaction: PatchMoneyTransactionBody, options?: SpacebringRequestOptions): Promise<undefined>;
|
|
33910
|
+
refund(transactionId: string, transaction?: RefundMoneyTransactionBody, options?: SpacebringRequestOptions): Promise<Refund>;
|
|
31277
33911
|
};
|
|
31278
33912
|
};
|
|
31279
33913
|
visitors: {
|
|
@@ -31374,4 +34008,4 @@ declare class SpacebringError extends Error {
|
|
|
31374
34008
|
});
|
|
31375
34009
|
}
|
|
31376
34010
|
|
|
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 };
|
|
34011
|
+
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 CreateEventMediaBody, 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 Media, 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 };
|