@izak0s/spacebring-api 3.6.0 → 5.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +32 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1766 -151
- package/dist/index.d.ts +1766 -151
- package/dist/index.js +32 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2435,6 +2435,26 @@ interface paths {
|
|
|
2435
2435
|
patch?: never;
|
|
2436
2436
|
trace?: never;
|
|
2437
2437
|
};
|
|
2438
|
+
"/transactions/credits/scheduled/v1": {
|
|
2439
|
+
parameters: {
|
|
2440
|
+
query?: never;
|
|
2441
|
+
header?: never;
|
|
2442
|
+
path?: never;
|
|
2443
|
+
cookie?: never;
|
|
2444
|
+
};
|
|
2445
|
+
/**
|
|
2446
|
+
* Retrieve scheduled credits transactions
|
|
2447
|
+
* @description Retrieve scheduled credits transactions of a subscription or a customer. <h3>OAuth</h3>Required scopes: <code>transactions.readonly</code> or <code>transactions</code>
|
|
2448
|
+
*/
|
|
2449
|
+
get: operations["getScheduledCreditsTransactions"];
|
|
2450
|
+
put?: never;
|
|
2451
|
+
post?: never;
|
|
2452
|
+
delete?: never;
|
|
2453
|
+
options?: never;
|
|
2454
|
+
head?: never;
|
|
2455
|
+
patch?: never;
|
|
2456
|
+
trace?: never;
|
|
2457
|
+
};
|
|
2438
2458
|
"/transactions/credits/v1": {
|
|
2439
2459
|
parameters: {
|
|
2440
2460
|
query?: never;
|
|
@@ -2459,6 +2479,26 @@ interface paths {
|
|
|
2459
2479
|
patch?: never;
|
|
2460
2480
|
trace?: never;
|
|
2461
2481
|
};
|
|
2482
|
+
"/transactions/credits/v1/{id}": {
|
|
2483
|
+
parameters: {
|
|
2484
|
+
query?: never;
|
|
2485
|
+
header?: never;
|
|
2486
|
+
path?: never;
|
|
2487
|
+
cookie?: never;
|
|
2488
|
+
};
|
|
2489
|
+
/**
|
|
2490
|
+
* Retrieve a credit transaction
|
|
2491
|
+
* @description Retrieve a credits transaction. <h3>OAuth</h3>Required scopes: <code>transactions.readonly</code> or <code>transactions</code>
|
|
2492
|
+
*/
|
|
2493
|
+
get: operations["getCreditsTransaction"];
|
|
2494
|
+
put?: never;
|
|
2495
|
+
post?: never;
|
|
2496
|
+
delete?: never;
|
|
2497
|
+
options?: never;
|
|
2498
|
+
head?: never;
|
|
2499
|
+
patch?: never;
|
|
2500
|
+
trace?: never;
|
|
2501
|
+
};
|
|
2462
2502
|
"/transactions/day_passes/scheduled/v1": {
|
|
2463
2503
|
parameters: {
|
|
2464
2504
|
query?: never;
|
|
@@ -3531,10 +3571,22 @@ interface components {
|
|
|
3531
3571
|
type: "company" | "user";
|
|
3532
3572
|
/** @description User details for membership customers. */
|
|
3533
3573
|
user?: {
|
|
3534
|
-
/**
|
|
3574
|
+
/** @description User bio. */
|
|
3575
|
+
about?: string | null;
|
|
3576
|
+
/** @description User email address. */
|
|
3577
|
+
email?: string | null;
|
|
3578
|
+
/**
|
|
3579
|
+
* Format: uuid
|
|
3580
|
+
* @description User ID.
|
|
3581
|
+
*/
|
|
3535
3582
|
id: string;
|
|
3583
|
+
/** @description First name. */
|
|
3536
3584
|
name?: string | null;
|
|
3585
|
+
/** @description Phone number. */
|
|
3586
|
+
phoneNumber?: string | null;
|
|
3587
|
+
/** @description Profile photo URL. */
|
|
3537
3588
|
photoUrl?: string | null;
|
|
3589
|
+
/** @description Last name. */
|
|
3538
3590
|
surname?: string | null;
|
|
3539
3591
|
};
|
|
3540
3592
|
};
|
|
@@ -3898,10 +3950,22 @@ interface components {
|
|
|
3898
3950
|
type: "company" | "user";
|
|
3899
3951
|
/** @description User details for membership customers. */
|
|
3900
3952
|
user?: {
|
|
3901
|
-
/**
|
|
3953
|
+
/** @description User bio. */
|
|
3954
|
+
about?: string | null;
|
|
3955
|
+
/** @description User email address. */
|
|
3956
|
+
email?: string | null;
|
|
3957
|
+
/**
|
|
3958
|
+
* Format: uuid
|
|
3959
|
+
* @description User ID.
|
|
3960
|
+
*/
|
|
3902
3961
|
id: string;
|
|
3962
|
+
/** @description First name. */
|
|
3903
3963
|
name?: string | null;
|
|
3964
|
+
/** @description Phone number. */
|
|
3965
|
+
phoneNumber?: string | null;
|
|
3966
|
+
/** @description Profile photo URL. */
|
|
3904
3967
|
photoUrl?: string | null;
|
|
3968
|
+
/** @description Last name. */
|
|
3905
3969
|
surname?: string | null;
|
|
3906
3970
|
};
|
|
3907
3971
|
};
|
|
@@ -4262,10 +4326,22 @@ interface components {
|
|
|
4262
4326
|
type: "company" | "user";
|
|
4263
4327
|
/** @description User details for membership customers. */
|
|
4264
4328
|
user?: {
|
|
4265
|
-
/**
|
|
4329
|
+
/** @description User bio. */
|
|
4330
|
+
about?: string | null;
|
|
4331
|
+
/** @description User email address. */
|
|
4332
|
+
email?: string | null;
|
|
4333
|
+
/**
|
|
4334
|
+
* Format: uuid
|
|
4335
|
+
* @description User ID.
|
|
4336
|
+
*/
|
|
4266
4337
|
id: string;
|
|
4338
|
+
/** @description First name. */
|
|
4267
4339
|
name?: string | null;
|
|
4340
|
+
/** @description Phone number. */
|
|
4341
|
+
phoneNumber?: string | null;
|
|
4342
|
+
/** @description Profile photo URL. */
|
|
4268
4343
|
photoUrl?: string | null;
|
|
4344
|
+
/** @description Last name. */
|
|
4269
4345
|
surname?: string | null;
|
|
4270
4346
|
};
|
|
4271
4347
|
};
|
|
@@ -5218,10 +5294,22 @@ interface components {
|
|
|
5218
5294
|
type: "company" | "user";
|
|
5219
5295
|
/** @description User details for membership customers. */
|
|
5220
5296
|
user?: {
|
|
5221
|
-
/**
|
|
5297
|
+
/** @description User bio. */
|
|
5298
|
+
about?: string | null;
|
|
5299
|
+
/** @description User email address. */
|
|
5300
|
+
email?: string | null;
|
|
5301
|
+
/**
|
|
5302
|
+
* Format: uuid
|
|
5303
|
+
* @description User ID.
|
|
5304
|
+
*/
|
|
5222
5305
|
id: string;
|
|
5306
|
+
/** @description First name. */
|
|
5223
5307
|
name?: string | null;
|
|
5308
|
+
/** @description Phone number. */
|
|
5309
|
+
phoneNumber?: string | null;
|
|
5310
|
+
/** @description Profile photo URL. */
|
|
5224
5311
|
photoUrl?: string | null;
|
|
5312
|
+
/** @description Last name. */
|
|
5225
5313
|
surname?: string | null;
|
|
5226
5314
|
};
|
|
5227
5315
|
};
|
|
@@ -5533,10 +5621,22 @@ interface components {
|
|
|
5533
5621
|
type: "company" | "user";
|
|
5534
5622
|
/** @description User details for membership customers. */
|
|
5535
5623
|
user?: {
|
|
5536
|
-
/**
|
|
5624
|
+
/** @description User bio. */
|
|
5625
|
+
about?: string | null;
|
|
5626
|
+
/** @description User email address. */
|
|
5627
|
+
email?: string | null;
|
|
5628
|
+
/**
|
|
5629
|
+
* Format: uuid
|
|
5630
|
+
* @description User ID.
|
|
5631
|
+
*/
|
|
5537
5632
|
id: string;
|
|
5633
|
+
/** @description First name. */
|
|
5538
5634
|
name?: string | null;
|
|
5635
|
+
/** @description Phone number. */
|
|
5636
|
+
phoneNumber?: string | null;
|
|
5637
|
+
/** @description Profile photo URL. */
|
|
5539
5638
|
photoUrl?: string | null;
|
|
5639
|
+
/** @description Last name. */
|
|
5540
5640
|
surname?: string | null;
|
|
5541
5641
|
};
|
|
5542
5642
|
};
|
|
@@ -12427,101 +12527,1469 @@ interface components {
|
|
|
12427
12527
|
*/
|
|
12428
12528
|
type: "assigneeUpdated" | "comment" | "statusUpdated" | "ticketCreated";
|
|
12429
12529
|
};
|
|
12430
|
-
|
|
12431
|
-
|
|
12432
|
-
|
|
12433
|
-
|
|
12434
|
-
|
|
12435
|
-
|
|
12436
|
-
|
|
12437
|
-
|
|
12438
|
-
|
|
12530
|
+
getScheduledCreditsTransactions: {
|
|
12531
|
+
/** @description Pagination token to fetch the next page of results. Returned when more results exist. */
|
|
12532
|
+
nextPageToken?: string;
|
|
12533
|
+
/** @description List of scheduled credits transactions. */
|
|
12534
|
+
scheduledTransactions: {
|
|
12535
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
12536
|
+
amount: number;
|
|
12537
|
+
/**
|
|
12538
|
+
* @deprecated
|
|
12539
|
+
* @description Deprecated. Use product instead.
|
|
12540
|
+
*/
|
|
12541
|
+
booking?: {
|
|
12542
|
+
/**
|
|
12543
|
+
* Format: uuid
|
|
12544
|
+
* @description Booking id.
|
|
12545
|
+
*/
|
|
12546
|
+
id: string;
|
|
12547
|
+
/** @description Booked resource. */
|
|
12548
|
+
resource: {
|
|
12549
|
+
/**
|
|
12550
|
+
* Format: uuid
|
|
12551
|
+
* @description Resource id.
|
|
12552
|
+
*/
|
|
12553
|
+
id: string;
|
|
12554
|
+
/** @description Resource title. */
|
|
12555
|
+
title: string;
|
|
12556
|
+
};
|
|
12439
12557
|
};
|
|
12440
|
-
|
|
12441
|
-
|
|
12442
|
-
|
|
12443
|
-
|
|
12444
|
-
|
|
12445
|
-
|
|
12446
|
-
|
|
12447
|
-
|
|
12448
|
-
|
|
12449
|
-
|
|
12450
|
-
|
|
12451
|
-
|
|
12452
|
-
|
|
12453
|
-
|
|
12454
|
-
|
|
12455
|
-
|
|
12456
|
-
|
|
12457
|
-
|
|
12458
|
-
|
|
12459
|
-
|
|
12460
|
-
/**
|
|
12461
|
-
|
|
12462
|
-
|
|
12558
|
+
/**
|
|
12559
|
+
* @deprecated
|
|
12560
|
+
* @description Deprecated. Use customer instead.
|
|
12561
|
+
*/
|
|
12562
|
+
company?: {
|
|
12563
|
+
/**
|
|
12564
|
+
* Format: date-time
|
|
12565
|
+
* @description ISO timestamp of company creation.
|
|
12566
|
+
*/
|
|
12567
|
+
createDate: string;
|
|
12568
|
+
/**
|
|
12569
|
+
* Format: uuid
|
|
12570
|
+
* @description Company id.
|
|
12571
|
+
*/
|
|
12572
|
+
id: string;
|
|
12573
|
+
/**
|
|
12574
|
+
* Format: uuid
|
|
12575
|
+
* @description Location id.
|
|
12576
|
+
*/
|
|
12577
|
+
locationRef: string;
|
|
12578
|
+
/** @description Company logo. */
|
|
12579
|
+
logo?: {
|
|
12580
|
+
/** @description Storage key of the company logo. */
|
|
12581
|
+
key: string;
|
|
12582
|
+
/** @description Public URL of the company logo. */
|
|
12583
|
+
url: string;
|
|
12584
|
+
};
|
|
12585
|
+
/** @description Company metadata. */
|
|
12586
|
+
metadata?: {
|
|
12587
|
+
[key: string]: unknown;
|
|
12588
|
+
};
|
|
12589
|
+
/** @description Internal notes. */
|
|
12590
|
+
notes?: string;
|
|
12591
|
+
/** @description Public logo URL derived from the company website. */
|
|
12592
|
+
publicLogoUrl?: string;
|
|
12593
|
+
/**
|
|
12594
|
+
* Format: uuid
|
|
12595
|
+
* @description Primary subscription id.
|
|
12596
|
+
*/
|
|
12597
|
+
subscriptionRef: string | null;
|
|
12598
|
+
/** @description Company name. */
|
|
12599
|
+
title: string;
|
|
12463
12600
|
};
|
|
12464
|
-
|
|
12465
|
-
|
|
12466
|
-
|
|
12601
|
+
/**
|
|
12602
|
+
* Format: uuid
|
|
12603
|
+
* @deprecated
|
|
12604
|
+
* @description Deprecated. Use customer instead.
|
|
12605
|
+
*/
|
|
12606
|
+
companyRef?: string;
|
|
12607
|
+
/**
|
|
12608
|
+
* Format: date-time
|
|
12609
|
+
* @description ISO timestamp of when the scheduled transaction was created.
|
|
12610
|
+
*/
|
|
12611
|
+
createDate: string;
|
|
12612
|
+
/** @description Customer associated with this scheduled transaction. */
|
|
12613
|
+
customer: {
|
|
12614
|
+
/**
|
|
12615
|
+
* Format: uuid
|
|
12616
|
+
* @description ID of the company or membership.
|
|
12617
|
+
*/
|
|
12618
|
+
id: string;
|
|
12619
|
+
/** @description Company logo. */
|
|
12620
|
+
logo?: {
|
|
12621
|
+
key: string;
|
|
12622
|
+
url: string;
|
|
12623
|
+
};
|
|
12624
|
+
/** @description Company name. */
|
|
12467
12625
|
title?: string;
|
|
12626
|
+
/**
|
|
12627
|
+
* @description Whether the customer is a company or a user.
|
|
12628
|
+
* @enum {string}
|
|
12629
|
+
*/
|
|
12630
|
+
type: "company" | "user";
|
|
12631
|
+
/** @description User details for membership customers. */
|
|
12632
|
+
user?: {
|
|
12633
|
+
about?: string | null;
|
|
12634
|
+
email?: string | null;
|
|
12635
|
+
/** Format: uuid */
|
|
12636
|
+
id: string;
|
|
12637
|
+
name?: string | null;
|
|
12638
|
+
phoneNumber?: string | null;
|
|
12639
|
+
photoUrl?: string | null;
|
|
12640
|
+
surname?: string | null;
|
|
12641
|
+
};
|
|
12468
12642
|
};
|
|
12643
|
+
/** @description Discounts applied to the scheduled transaction. */
|
|
12644
|
+
discounts?: {
|
|
12645
|
+
/** @description Applied coupon. */
|
|
12646
|
+
coupon: {
|
|
12647
|
+
/** @description Fixed amount discount. */
|
|
12648
|
+
amountOff?: number;
|
|
12649
|
+
/** @description Currency of the fixed amount discount. */
|
|
12650
|
+
currencyCode?: string;
|
|
12651
|
+
/** @description Coupon id. */
|
|
12652
|
+
id: string;
|
|
12653
|
+
/** @description Percentage discount. */
|
|
12654
|
+
percentOff?: number;
|
|
12655
|
+
/** @description Product types the coupon applies to. */
|
|
12656
|
+
productTypes?: string[];
|
|
12657
|
+
/** @description Coupon type. */
|
|
12658
|
+
type: string;
|
|
12659
|
+
};
|
|
12660
|
+
/** @description Promocode the coupon was applied with. */
|
|
12661
|
+
promocode?: {
|
|
12662
|
+
/** @description Promocode. */
|
|
12663
|
+
code: string;
|
|
12664
|
+
/** @description Promocode expiration date. */
|
|
12665
|
+
expiration?: string;
|
|
12666
|
+
/**
|
|
12667
|
+
* Format: uuid
|
|
12668
|
+
* @description Promocode id.
|
|
12669
|
+
*/
|
|
12670
|
+
id: string;
|
|
12671
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
12672
|
+
limitByFirstPurchase?: boolean;
|
|
12673
|
+
};
|
|
12674
|
+
/**
|
|
12675
|
+
* Format: uuid
|
|
12676
|
+
* @description ID of the subscription this discount is associated with.
|
|
12677
|
+
*/
|
|
12678
|
+
subscriptionId?: string;
|
|
12679
|
+
}[];
|
|
12680
|
+
/**
|
|
12681
|
+
* Format: uuid
|
|
12682
|
+
* @description Unique identifier of the scheduled transaction.
|
|
12683
|
+
*/
|
|
12684
|
+
id: string;
|
|
12685
|
+
/**
|
|
12686
|
+
* Format: uuid
|
|
12687
|
+
* @description ID of the organization (location).
|
|
12688
|
+
*/
|
|
12689
|
+
locationRef: string;
|
|
12690
|
+
/**
|
|
12691
|
+
* Format: uuid
|
|
12692
|
+
* @deprecated
|
|
12693
|
+
* @description Deprecated. Use customer instead.
|
|
12694
|
+
*/
|
|
12695
|
+
membershipRef?: string;
|
|
12696
|
+
/**
|
|
12697
|
+
* Format: uuid
|
|
12698
|
+
* @deprecated
|
|
12699
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12700
|
+
*/
|
|
12701
|
+
membershipRefCreator?: string;
|
|
12702
|
+
/**
|
|
12703
|
+
* Format: uuid
|
|
12704
|
+
* @description ID of the network.
|
|
12705
|
+
*/
|
|
12706
|
+
networkRef: string;
|
|
12707
|
+
/** @description Product details. */
|
|
12708
|
+
product?: {
|
|
12709
|
+
/**
|
|
12710
|
+
* Format: uuid
|
|
12711
|
+
* @description ID of the associated booking.
|
|
12712
|
+
*/
|
|
12713
|
+
bookingRef?: string;
|
|
12714
|
+
/** @description Display title of the product. */
|
|
12715
|
+
title: string;
|
|
12716
|
+
/**
|
|
12717
|
+
* @description Product type.
|
|
12718
|
+
* @enum {string}
|
|
12719
|
+
*/
|
|
12720
|
+
type: "booking";
|
|
12721
|
+
};
|
|
12722
|
+
/**
|
|
12723
|
+
* Format: date-time
|
|
12724
|
+
* @description ISO timestamp of when the scheduled transaction was resolved into a credits transaction.
|
|
12725
|
+
*/
|
|
12726
|
+
resolveDate?: string;
|
|
12727
|
+
/**
|
|
12728
|
+
* Format: date-time
|
|
12729
|
+
* @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into.
|
|
12730
|
+
*/
|
|
12731
|
+
scheduleDate: string;
|
|
12732
|
+
/** @description Transaction status. */
|
|
12733
|
+
status: string;
|
|
12734
|
+
/** @description Timezone of the subscription. */
|
|
12735
|
+
timezoneId: string;
|
|
12736
|
+
/**
|
|
12737
|
+
* @description Scheduled credits transaction type.
|
|
12738
|
+
* @enum {string}
|
|
12739
|
+
*/
|
|
12740
|
+
type: "booking";
|
|
12741
|
+
/**
|
|
12742
|
+
* @deprecated
|
|
12743
|
+
* @description Deprecated. Use userOwner instead.
|
|
12744
|
+
*/
|
|
12745
|
+
user?: {
|
|
12746
|
+
about?: string | null;
|
|
12747
|
+
email?: string | null;
|
|
12748
|
+
/** Format: uuid */
|
|
12749
|
+
id: string;
|
|
12750
|
+
name?: string | null;
|
|
12751
|
+
phoneNumber?: string | null;
|
|
12752
|
+
photoUrl?: string | null;
|
|
12753
|
+
surname?: string | null;
|
|
12754
|
+
};
|
|
12755
|
+
/** @description User who created the transaction. */
|
|
12756
|
+
userCreatedBy?: {
|
|
12757
|
+
about?: string | null;
|
|
12758
|
+
email?: string | null;
|
|
12759
|
+
/** Format: uuid */
|
|
12760
|
+
id: string;
|
|
12761
|
+
name?: string | null;
|
|
12762
|
+
phoneNumber?: string | null;
|
|
12763
|
+
photoUrl?: string | null;
|
|
12764
|
+
surname?: string | null;
|
|
12765
|
+
};
|
|
12766
|
+
/**
|
|
12767
|
+
* @deprecated
|
|
12768
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12769
|
+
*/
|
|
12770
|
+
userCreator?: {
|
|
12771
|
+
about?: string | null;
|
|
12772
|
+
email?: string | null;
|
|
12773
|
+
/** Format: uuid */
|
|
12774
|
+
id: string;
|
|
12775
|
+
name?: string | null;
|
|
12776
|
+
phoneNumber?: string | null;
|
|
12777
|
+
photoUrl?: string | null;
|
|
12778
|
+
surname?: string | null;
|
|
12779
|
+
};
|
|
12780
|
+
/**
|
|
12781
|
+
* @deprecated
|
|
12782
|
+
* @description Deprecated. Use customer.user instead.
|
|
12783
|
+
*/
|
|
12784
|
+
userOwner?: {
|
|
12785
|
+
about?: string | null;
|
|
12786
|
+
email?: string | null;
|
|
12787
|
+
/** Format: uuid */
|
|
12788
|
+
id: string;
|
|
12789
|
+
name?: string | null;
|
|
12790
|
+
phoneNumber?: string | null;
|
|
12791
|
+
photoUrl?: string | null;
|
|
12792
|
+
surname?: string | null;
|
|
12793
|
+
};
|
|
12794
|
+
/**
|
|
12795
|
+
* Format: uuid
|
|
12796
|
+
* @deprecated
|
|
12797
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12798
|
+
*/
|
|
12799
|
+
userRefCreator?: string;
|
|
12800
|
+
/**
|
|
12801
|
+
* Format: uuid
|
|
12802
|
+
* @deprecated
|
|
12803
|
+
* @description Deprecated. Use customer.user instead.
|
|
12804
|
+
*/
|
|
12805
|
+
userRefOwner?: string;
|
|
12806
|
+
}[];
|
|
12807
|
+
/** @description Query string with nextPageToken and the request filter to fetch the next page of results. Returned when more results exist. */
|
|
12808
|
+
searchQueryNext?: string;
|
|
12809
|
+
};
|
|
12810
|
+
getCreditsTransactions: {
|
|
12811
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
12812
|
+
nextPageToken?: string;
|
|
12813
|
+
/** @description Ready-to-use query string with the current filters and nextPageToken to fetch the next page of results. */
|
|
12814
|
+
searchQueryNext?: string;
|
|
12815
|
+
/** @description List of credits transactions. */
|
|
12816
|
+
transactions: {
|
|
12817
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
12818
|
+
amount: number;
|
|
12819
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
12820
|
+
amounts: {
|
|
12821
|
+
/** @description Amount deducted from this balance bucket. */
|
|
12822
|
+
amount: number;
|
|
12823
|
+
/**
|
|
12824
|
+
* Format: date-time
|
|
12825
|
+
* @description Expiration date for expiring balances.
|
|
12826
|
+
*/
|
|
12827
|
+
expirationDate?: string;
|
|
12828
|
+
/**
|
|
12829
|
+
* Format: uuid
|
|
12830
|
+
* @description Subscription associated with expiring balances.
|
|
12831
|
+
*/
|
|
12832
|
+
subscriptionRef?: string;
|
|
12833
|
+
/**
|
|
12834
|
+
* @description Balance bucket type.
|
|
12835
|
+
* @enum {string}
|
|
12836
|
+
*/
|
|
12837
|
+
type: "expiring" | "permanent";
|
|
12838
|
+
}[];
|
|
12839
|
+
/**
|
|
12840
|
+
* @deprecated
|
|
12841
|
+
* @description Deprecated. Use product instead.
|
|
12842
|
+
*/
|
|
12843
|
+
booking?: {
|
|
12844
|
+
/**
|
|
12845
|
+
* Format: date-time
|
|
12846
|
+
* @description Booking end date.
|
|
12847
|
+
*/
|
|
12848
|
+
endDate?: string;
|
|
12849
|
+
/**
|
|
12850
|
+
* Format: uuid
|
|
12851
|
+
* @description Booking id.
|
|
12852
|
+
*/
|
|
12853
|
+
id: string;
|
|
12854
|
+
/** @description Booked resource. */
|
|
12855
|
+
resource: {
|
|
12856
|
+
/**
|
|
12857
|
+
* Format: uuid
|
|
12858
|
+
* @description Resource id.
|
|
12859
|
+
*/
|
|
12860
|
+
id: string;
|
|
12861
|
+
/** @description Resource title. */
|
|
12862
|
+
title: string;
|
|
12863
|
+
};
|
|
12864
|
+
/**
|
|
12865
|
+
* Format: date-time
|
|
12866
|
+
* @description Booking start date.
|
|
12867
|
+
*/
|
|
12868
|
+
startDate?: string;
|
|
12869
|
+
};
|
|
12870
|
+
/**
|
|
12871
|
+
* @deprecated
|
|
12872
|
+
* @description Deprecated. Use customer instead.
|
|
12873
|
+
*/
|
|
12874
|
+
company?: {
|
|
12875
|
+
/**
|
|
12876
|
+
* Format: date-time
|
|
12877
|
+
* @description ISO timestamp of company creation.
|
|
12878
|
+
*/
|
|
12879
|
+
createDate: string;
|
|
12880
|
+
/**
|
|
12881
|
+
* Format: uuid
|
|
12882
|
+
* @description Company id.
|
|
12883
|
+
*/
|
|
12884
|
+
id: string;
|
|
12885
|
+
/**
|
|
12886
|
+
* Format: uuid
|
|
12887
|
+
* @description Location id.
|
|
12888
|
+
*/
|
|
12889
|
+
locationRef: string;
|
|
12890
|
+
/** @description Company logo. */
|
|
12891
|
+
logo?: {
|
|
12892
|
+
/** @description Storage key of the company logo. */
|
|
12893
|
+
key: string;
|
|
12894
|
+
/** @description Public URL of the company logo. */
|
|
12895
|
+
url: string;
|
|
12896
|
+
};
|
|
12897
|
+
/** @description Company metadata. */
|
|
12898
|
+
metadata?: {
|
|
12899
|
+
[key: string]: unknown;
|
|
12900
|
+
};
|
|
12901
|
+
/** @description Internal notes. */
|
|
12902
|
+
notes?: string;
|
|
12903
|
+
/** @description Public logo URL derived from the company website. */
|
|
12904
|
+
publicLogoUrl?: string;
|
|
12905
|
+
/**
|
|
12906
|
+
* Format: uuid
|
|
12907
|
+
* @description Primary subscription id.
|
|
12908
|
+
*/
|
|
12909
|
+
subscriptionRef: string | null;
|
|
12910
|
+
/** @description Company name. */
|
|
12911
|
+
title: string;
|
|
12912
|
+
};
|
|
12913
|
+
/**
|
|
12914
|
+
* Format: uuid
|
|
12915
|
+
* @deprecated
|
|
12916
|
+
* @description Deprecated. Use customer instead.
|
|
12917
|
+
*/
|
|
12918
|
+
companyRef?: string;
|
|
12919
|
+
/**
|
|
12920
|
+
* Format: date-time
|
|
12921
|
+
* @description ISO timestamp of when the transaction was created.
|
|
12922
|
+
*/
|
|
12923
|
+
createDate: string;
|
|
12924
|
+
/** @description Customer associated with this transaction. */
|
|
12925
|
+
customer: {
|
|
12926
|
+
/**
|
|
12927
|
+
* Format: uuid
|
|
12928
|
+
* @description ID of the company or membership.
|
|
12929
|
+
*/
|
|
12930
|
+
id: string;
|
|
12931
|
+
/** @description Company logo. */
|
|
12932
|
+
logo?: {
|
|
12933
|
+
key: string;
|
|
12934
|
+
url: string;
|
|
12935
|
+
};
|
|
12936
|
+
/** @description Company name. */
|
|
12937
|
+
title?: string;
|
|
12938
|
+
/**
|
|
12939
|
+
* @description Whether the customer is a company or a user.
|
|
12940
|
+
* @enum {string}
|
|
12941
|
+
*/
|
|
12942
|
+
type: "company" | "user";
|
|
12943
|
+
/** @description User details for membership customers. */
|
|
12944
|
+
user?: {
|
|
12945
|
+
about?: string | null;
|
|
12946
|
+
email?: string | null;
|
|
12947
|
+
/** Format: uuid */
|
|
12948
|
+
id: string;
|
|
12949
|
+
name?: string | null;
|
|
12950
|
+
phoneNumber?: string | null;
|
|
12951
|
+
photoUrl?: string | null;
|
|
12952
|
+
surname?: string | null;
|
|
12953
|
+
};
|
|
12954
|
+
};
|
|
12955
|
+
/** @description Transaction description. */
|
|
12956
|
+
description?: string;
|
|
12957
|
+
/** @description Discounts applied to the transaction. */
|
|
12958
|
+
discounts?: {
|
|
12959
|
+
/** @description Applied coupon. */
|
|
12960
|
+
coupon: {
|
|
12961
|
+
/** @description Fixed amount discount. */
|
|
12962
|
+
amountOff?: number;
|
|
12963
|
+
/** @description Currency of the fixed amount discount. */
|
|
12964
|
+
currencyCode?: string;
|
|
12965
|
+
/** @description Coupon id. */
|
|
12966
|
+
id: string;
|
|
12967
|
+
/** @description Percentage discount. */
|
|
12968
|
+
percentOff?: number;
|
|
12969
|
+
/** @description Product types the coupon applies to. */
|
|
12970
|
+
productTypes?: string[];
|
|
12971
|
+
/** @description Coupon type. */
|
|
12972
|
+
type: string;
|
|
12973
|
+
};
|
|
12974
|
+
/** @description Promocode the coupon was applied with. */
|
|
12975
|
+
promocode?: {
|
|
12976
|
+
/** @description Promocode. */
|
|
12977
|
+
code: string;
|
|
12978
|
+
/** @description Promocode expiration date. */
|
|
12979
|
+
expiration?: string;
|
|
12980
|
+
/**
|
|
12981
|
+
* Format: uuid
|
|
12982
|
+
* @description Promocode id.
|
|
12983
|
+
*/
|
|
12984
|
+
id: string;
|
|
12985
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
12986
|
+
limitByFirstPurchase?: boolean;
|
|
12987
|
+
};
|
|
12988
|
+
/**
|
|
12989
|
+
* Format: uuid
|
|
12990
|
+
* @description ID of the subscription this discount is associated with.
|
|
12991
|
+
*/
|
|
12992
|
+
subscriptionId?: string;
|
|
12993
|
+
}[];
|
|
12994
|
+
/**
|
|
12995
|
+
* @deprecated
|
|
12996
|
+
* @description Deprecated. Use amounts instead.
|
|
12997
|
+
*/
|
|
12998
|
+
expiringAmount?: number;
|
|
12999
|
+
/**
|
|
13000
|
+
* Format: uuid
|
|
13001
|
+
* @description Unique identifier of the transaction.
|
|
13002
|
+
*/
|
|
13003
|
+
id: string;
|
|
13004
|
+
/**
|
|
13005
|
+
* Format: uuid
|
|
13006
|
+
* @description ID of the organization (location).
|
|
13007
|
+
*/
|
|
13008
|
+
locationRef: string;
|
|
13009
|
+
/**
|
|
13010
|
+
* Format: uuid
|
|
13011
|
+
* @deprecated
|
|
13012
|
+
* @description Deprecated. Use customer instead.
|
|
13013
|
+
*/
|
|
13014
|
+
membershipRef?: string;
|
|
13015
|
+
/**
|
|
13016
|
+
* Format: uuid
|
|
13017
|
+
* @deprecated
|
|
13018
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13019
|
+
*/
|
|
13020
|
+
membershipRefCreator?: string;
|
|
13021
|
+
/**
|
|
13022
|
+
* Format: uuid
|
|
13023
|
+
* @description ID of the network.
|
|
13024
|
+
*/
|
|
13025
|
+
networkRef: string;
|
|
13026
|
+
/**
|
|
13027
|
+
* @deprecated
|
|
13028
|
+
* @description Deprecated. Use product instead.
|
|
13029
|
+
*/
|
|
13030
|
+
order?: {
|
|
13031
|
+
/**
|
|
13032
|
+
* Format: uuid
|
|
13033
|
+
* @description Order id.
|
|
13034
|
+
*/
|
|
13035
|
+
id: string;
|
|
13036
|
+
/** @description Order items. */
|
|
13037
|
+
items: {
|
|
13038
|
+
/**
|
|
13039
|
+
* Format: uuid
|
|
13040
|
+
* @description Order item id.
|
|
13041
|
+
*/
|
|
13042
|
+
id: string;
|
|
13043
|
+
/** @description Ordered product. */
|
|
13044
|
+
product: {
|
|
13045
|
+
/**
|
|
13046
|
+
* Format: uuid
|
|
13047
|
+
* @description Product id.
|
|
13048
|
+
*/
|
|
13049
|
+
id: string;
|
|
13050
|
+
/** @description Product option. */
|
|
13051
|
+
option?: {
|
|
13052
|
+
/**
|
|
13053
|
+
* Format: uuid
|
|
13054
|
+
* @description Product option id.
|
|
13055
|
+
*/
|
|
13056
|
+
id: string;
|
|
13057
|
+
/** @description Product option title. */
|
|
13058
|
+
title: string;
|
|
13059
|
+
};
|
|
13060
|
+
/** @description Product title. */
|
|
13061
|
+
title: string;
|
|
13062
|
+
};
|
|
13063
|
+
/** @description Quantity of units. */
|
|
13064
|
+
quantity: number;
|
|
13065
|
+
}[];
|
|
13066
|
+
};
|
|
13067
|
+
/**
|
|
13068
|
+
* @deprecated
|
|
13069
|
+
* @description Deprecated. Use amounts instead.
|
|
13070
|
+
*/
|
|
13071
|
+
permanentAmount?: number;
|
|
13072
|
+
/** @description Product details. */
|
|
13073
|
+
product?: {
|
|
13074
|
+
/**
|
|
13075
|
+
* Format: uuid
|
|
13076
|
+
* @description ID of the associated booking.
|
|
13077
|
+
*/
|
|
13078
|
+
bookingRef?: string;
|
|
13079
|
+
/**
|
|
13080
|
+
* Format: uuid
|
|
13081
|
+
* @description ID of the associated event ticket.
|
|
13082
|
+
*/
|
|
13083
|
+
eventTicketRef?: string;
|
|
13084
|
+
/**
|
|
13085
|
+
* Format: uuid
|
|
13086
|
+
* @description ID of the associated order.
|
|
13087
|
+
*/
|
|
13088
|
+
orderRef?: string;
|
|
13089
|
+
/** @description Display title of the product. */
|
|
13090
|
+
title?: string;
|
|
13091
|
+
/**
|
|
13092
|
+
* @description Product type.
|
|
13093
|
+
* @enum {string}
|
|
13094
|
+
*/
|
|
13095
|
+
type?: "booking" | "eventTicket" | "order";
|
|
13096
|
+
};
|
|
13097
|
+
/**
|
|
13098
|
+
* @deprecated
|
|
13099
|
+
* @description Deprecated.
|
|
13100
|
+
*/
|
|
13101
|
+
refund?: {
|
|
13102
|
+
/** @description Refunded amount. */
|
|
13103
|
+
amount: number;
|
|
13104
|
+
/**
|
|
13105
|
+
* Format: date-time
|
|
13106
|
+
* @description Refund creation timestamp.
|
|
13107
|
+
*/
|
|
13108
|
+
createDate: string;
|
|
13109
|
+
};
|
|
13110
|
+
/** @description Transaction status. */
|
|
13111
|
+
status: string;
|
|
13112
|
+
/**
|
|
13113
|
+
* @deprecated
|
|
13114
|
+
* @description Deprecated. Use product instead.
|
|
13115
|
+
*/
|
|
13116
|
+
ticket?: {
|
|
13117
|
+
/**
|
|
13118
|
+
* Format: date-time
|
|
13119
|
+
* @description Ticket creation timestamp.
|
|
13120
|
+
*/
|
|
13121
|
+
createDate?: string;
|
|
13122
|
+
/** @description Event details. */
|
|
13123
|
+
event?: {
|
|
13124
|
+
/**
|
|
13125
|
+
* Format: date-time
|
|
13126
|
+
* @description Event end date.
|
|
13127
|
+
*/
|
|
13128
|
+
endDate?: string;
|
|
13129
|
+
/**
|
|
13130
|
+
* Format: uuid
|
|
13131
|
+
* @description Event id.
|
|
13132
|
+
*/
|
|
13133
|
+
id: string;
|
|
13134
|
+
/**
|
|
13135
|
+
* Format: date-time
|
|
13136
|
+
* @description Event start date.
|
|
13137
|
+
*/
|
|
13138
|
+
startDate?: string;
|
|
13139
|
+
/** @description Event title. */
|
|
13140
|
+
title: string;
|
|
13141
|
+
};
|
|
13142
|
+
/**
|
|
13143
|
+
* Format: uuid
|
|
13144
|
+
* @description Ticket id.
|
|
13145
|
+
*/
|
|
13146
|
+
id: string;
|
|
13147
|
+
/** @description Number of tickets. */
|
|
13148
|
+
quantity: number;
|
|
13149
|
+
};
|
|
13150
|
+
/**
|
|
13151
|
+
* @description Credits transaction type.
|
|
13152
|
+
* @enum {string}
|
|
13153
|
+
*/
|
|
13154
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "eventTicket" | "expiration" | "order" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
13155
|
+
/** @description User who created the transaction. */
|
|
13156
|
+
userCreatedBy?: {
|
|
13157
|
+
about?: string | null;
|
|
13158
|
+
email?: string | null;
|
|
13159
|
+
/** Format: uuid */
|
|
13160
|
+
id: string;
|
|
13161
|
+
name?: string | null;
|
|
13162
|
+
phoneNumber?: string | null;
|
|
13163
|
+
photoUrl?: string | null;
|
|
13164
|
+
surname?: string | null;
|
|
13165
|
+
};
|
|
13166
|
+
/**
|
|
13167
|
+
* @deprecated
|
|
13168
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13169
|
+
*/
|
|
13170
|
+
userCreator?: {
|
|
13171
|
+
about?: string | null;
|
|
13172
|
+
email?: string | null;
|
|
13173
|
+
/** Format: uuid */
|
|
13174
|
+
id: string;
|
|
13175
|
+
name?: string | null;
|
|
13176
|
+
phoneNumber?: string | null;
|
|
13177
|
+
photoUrl?: string | null;
|
|
13178
|
+
surname?: string | null;
|
|
13179
|
+
};
|
|
13180
|
+
/**
|
|
13181
|
+
* @deprecated
|
|
13182
|
+
* @description Deprecated. Use customer.user instead.
|
|
13183
|
+
*/
|
|
13184
|
+
userOwner?: {
|
|
13185
|
+
about?: string | null;
|
|
13186
|
+
email?: string | null;
|
|
13187
|
+
/** Format: uuid */
|
|
13188
|
+
id: string;
|
|
13189
|
+
name?: string | null;
|
|
13190
|
+
phoneNumber?: string | null;
|
|
13191
|
+
photoUrl?: string | null;
|
|
13192
|
+
surname?: string | null;
|
|
13193
|
+
};
|
|
13194
|
+
/**
|
|
13195
|
+
* Format: uuid
|
|
13196
|
+
* @deprecated
|
|
13197
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13198
|
+
*/
|
|
13199
|
+
userRefCreator?: string;
|
|
13200
|
+
/**
|
|
13201
|
+
* Format: uuid
|
|
13202
|
+
* @deprecated
|
|
13203
|
+
* @description Deprecated. Use customer.user instead.
|
|
13204
|
+
*/
|
|
13205
|
+
userRefOwner?: string;
|
|
13206
|
+
}[];
|
|
13207
|
+
};
|
|
13208
|
+
createCreditsTransaction: {
|
|
13209
|
+
/** @description The created credits transaction. */
|
|
13210
|
+
transaction: {
|
|
13211
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
13212
|
+
amount: number;
|
|
13213
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
13214
|
+
amounts: {
|
|
13215
|
+
/** @description Amount deducted from this balance bucket. */
|
|
13216
|
+
amount: number;
|
|
13217
|
+
/**
|
|
13218
|
+
* Format: date-time
|
|
13219
|
+
* @description Expiration date for expiring balances.
|
|
13220
|
+
*/
|
|
13221
|
+
expirationDate?: string;
|
|
13222
|
+
/**
|
|
13223
|
+
* Format: uuid
|
|
13224
|
+
* @description Subscription associated with expiring balances.
|
|
13225
|
+
*/
|
|
13226
|
+
subscriptionRef?: string;
|
|
13227
|
+
/**
|
|
13228
|
+
* @description Balance bucket type.
|
|
13229
|
+
* @enum {string}
|
|
13230
|
+
*/
|
|
13231
|
+
type: "expiring" | "permanent";
|
|
13232
|
+
}[];
|
|
13233
|
+
/**
|
|
13234
|
+
* @deprecated
|
|
13235
|
+
* @description Deprecated. Use product instead.
|
|
13236
|
+
*/
|
|
13237
|
+
booking?: {
|
|
13238
|
+
/**
|
|
13239
|
+
* Format: date-time
|
|
13240
|
+
* @description Booking end date.
|
|
13241
|
+
*/
|
|
13242
|
+
endDate?: string;
|
|
13243
|
+
/**
|
|
13244
|
+
* Format: uuid
|
|
13245
|
+
* @description Booking id.
|
|
13246
|
+
*/
|
|
13247
|
+
id: string;
|
|
13248
|
+
/** @description Booked resource. */
|
|
13249
|
+
resource: {
|
|
13250
|
+
/**
|
|
13251
|
+
* Format: uuid
|
|
13252
|
+
* @description Resource id.
|
|
13253
|
+
*/
|
|
13254
|
+
id: string;
|
|
13255
|
+
/** @description Resource title. */
|
|
13256
|
+
title: string;
|
|
13257
|
+
};
|
|
13258
|
+
/**
|
|
13259
|
+
* Format: date-time
|
|
13260
|
+
* @description Booking start date.
|
|
13261
|
+
*/
|
|
13262
|
+
startDate?: string;
|
|
13263
|
+
};
|
|
13264
|
+
/**
|
|
13265
|
+
* @deprecated
|
|
13266
|
+
* @description Deprecated. Use customer instead.
|
|
13267
|
+
*/
|
|
13268
|
+
company?: {
|
|
13269
|
+
/**
|
|
13270
|
+
* Format: date-time
|
|
13271
|
+
* @description ISO timestamp of company creation.
|
|
13272
|
+
*/
|
|
13273
|
+
createDate: string;
|
|
13274
|
+
/**
|
|
13275
|
+
* Format: uuid
|
|
13276
|
+
* @description Company id.
|
|
13277
|
+
*/
|
|
13278
|
+
id: string;
|
|
13279
|
+
/**
|
|
13280
|
+
* Format: uuid
|
|
13281
|
+
* @description Location id.
|
|
13282
|
+
*/
|
|
13283
|
+
locationRef: string;
|
|
13284
|
+
/** @description Company logo. */
|
|
13285
|
+
logo?: {
|
|
13286
|
+
/** @description Storage key of the company logo. */
|
|
13287
|
+
key: string;
|
|
13288
|
+
/** @description Public URL of the company logo. */
|
|
13289
|
+
url: string;
|
|
13290
|
+
};
|
|
13291
|
+
/** @description Company metadata. */
|
|
13292
|
+
metadata?: {
|
|
13293
|
+
[key: string]: unknown;
|
|
13294
|
+
};
|
|
13295
|
+
/** @description Internal notes. */
|
|
13296
|
+
notes?: string;
|
|
13297
|
+
/** @description Public logo URL derived from the company website. */
|
|
13298
|
+
publicLogoUrl?: string;
|
|
13299
|
+
/**
|
|
13300
|
+
* Format: uuid
|
|
13301
|
+
* @description Primary subscription id.
|
|
13302
|
+
*/
|
|
13303
|
+
subscriptionRef: string | null;
|
|
13304
|
+
/** @description Company name. */
|
|
13305
|
+
title: string;
|
|
13306
|
+
};
|
|
13307
|
+
/**
|
|
13308
|
+
* Format: uuid
|
|
13309
|
+
* @deprecated
|
|
13310
|
+
* @description Deprecated. Use customer instead.
|
|
13311
|
+
*/
|
|
13312
|
+
companyRef?: string;
|
|
13313
|
+
/**
|
|
13314
|
+
* Format: date-time
|
|
13315
|
+
* @description ISO timestamp of when the transaction was created.
|
|
13316
|
+
*/
|
|
13317
|
+
createDate: string;
|
|
13318
|
+
/** @description Customer associated with this transaction. */
|
|
13319
|
+
customer: {
|
|
13320
|
+
/**
|
|
13321
|
+
* Format: uuid
|
|
13322
|
+
* @description ID of the company or membership.
|
|
13323
|
+
*/
|
|
13324
|
+
id: string;
|
|
13325
|
+
/** @description Company logo. */
|
|
13326
|
+
logo?: {
|
|
13327
|
+
key: string;
|
|
13328
|
+
url: string;
|
|
13329
|
+
};
|
|
13330
|
+
/** @description Company name. */
|
|
13331
|
+
title?: string;
|
|
13332
|
+
/**
|
|
13333
|
+
* @description Whether the customer is a company or a user.
|
|
13334
|
+
* @enum {string}
|
|
13335
|
+
*/
|
|
13336
|
+
type: "company" | "user";
|
|
13337
|
+
/** @description User details for membership customers. */
|
|
13338
|
+
user?: {
|
|
13339
|
+
about?: string | null;
|
|
13340
|
+
email?: string | null;
|
|
13341
|
+
/** Format: uuid */
|
|
13342
|
+
id: string;
|
|
13343
|
+
name?: string | null;
|
|
13344
|
+
phoneNumber?: string | null;
|
|
13345
|
+
photoUrl?: string | null;
|
|
13346
|
+
surname?: string | null;
|
|
13347
|
+
};
|
|
13348
|
+
};
|
|
13349
|
+
/** @description Transaction description. */
|
|
13350
|
+
description?: string;
|
|
13351
|
+
/** @description Discounts applied to the transaction. */
|
|
13352
|
+
discounts?: {
|
|
13353
|
+
/** @description Applied coupon. */
|
|
13354
|
+
coupon: {
|
|
13355
|
+
/** @description Fixed amount discount. */
|
|
13356
|
+
amountOff?: number;
|
|
13357
|
+
/** @description Currency of the fixed amount discount. */
|
|
13358
|
+
currencyCode?: string;
|
|
13359
|
+
/** @description Coupon id. */
|
|
13360
|
+
id: string;
|
|
13361
|
+
/** @description Percentage discount. */
|
|
13362
|
+
percentOff?: number;
|
|
13363
|
+
/** @description Product types the coupon applies to. */
|
|
13364
|
+
productTypes?: string[];
|
|
13365
|
+
/** @description Coupon type. */
|
|
13366
|
+
type: string;
|
|
13367
|
+
};
|
|
13368
|
+
/** @description Promocode the coupon was applied with. */
|
|
13369
|
+
promocode?: {
|
|
13370
|
+
/** @description Promocode. */
|
|
13371
|
+
code: string;
|
|
13372
|
+
/** @description Promocode expiration date. */
|
|
13373
|
+
expiration?: string;
|
|
13374
|
+
/**
|
|
13375
|
+
* Format: uuid
|
|
13376
|
+
* @description Promocode id.
|
|
13377
|
+
*/
|
|
13378
|
+
id: string;
|
|
13379
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
13380
|
+
limitByFirstPurchase?: boolean;
|
|
13381
|
+
};
|
|
13382
|
+
/**
|
|
13383
|
+
* Format: uuid
|
|
13384
|
+
* @description ID of the subscription this discount is associated with.
|
|
13385
|
+
*/
|
|
13386
|
+
subscriptionId?: string;
|
|
13387
|
+
}[];
|
|
13388
|
+
/**
|
|
13389
|
+
* @deprecated
|
|
13390
|
+
* @description Deprecated. Use amounts instead.
|
|
13391
|
+
*/
|
|
13392
|
+
expiringAmount?: number;
|
|
13393
|
+
/**
|
|
13394
|
+
* Format: uuid
|
|
13395
|
+
* @description Unique identifier of the transaction.
|
|
13396
|
+
*/
|
|
13397
|
+
id: string;
|
|
13398
|
+
/**
|
|
13399
|
+
* Format: uuid
|
|
13400
|
+
* @description ID of the organization (location).
|
|
13401
|
+
*/
|
|
13402
|
+
locationRef: string;
|
|
13403
|
+
/**
|
|
13404
|
+
* Format: uuid
|
|
13405
|
+
* @deprecated
|
|
13406
|
+
* @description Deprecated. Use customer instead.
|
|
13407
|
+
*/
|
|
13408
|
+
membershipRef?: string;
|
|
13409
|
+
/**
|
|
13410
|
+
* Format: uuid
|
|
13411
|
+
* @deprecated
|
|
13412
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13413
|
+
*/
|
|
13414
|
+
membershipRefCreator?: string;
|
|
13415
|
+
/**
|
|
13416
|
+
* Format: uuid
|
|
13417
|
+
* @description ID of the network.
|
|
13418
|
+
*/
|
|
13419
|
+
networkRef: string;
|
|
13420
|
+
/**
|
|
13421
|
+
* @deprecated
|
|
13422
|
+
* @description Deprecated. Use product instead.
|
|
13423
|
+
*/
|
|
13424
|
+
order?: {
|
|
13425
|
+
/**
|
|
13426
|
+
* Format: uuid
|
|
13427
|
+
* @description Order id.
|
|
13428
|
+
*/
|
|
13429
|
+
id: string;
|
|
13430
|
+
/** @description Order items. */
|
|
13431
|
+
items: {
|
|
13432
|
+
/**
|
|
13433
|
+
* Format: uuid
|
|
13434
|
+
* @description Order item id.
|
|
13435
|
+
*/
|
|
13436
|
+
id: string;
|
|
13437
|
+
/** @description Ordered product. */
|
|
13438
|
+
product: {
|
|
13439
|
+
/**
|
|
13440
|
+
* Format: uuid
|
|
13441
|
+
* @description Product id.
|
|
13442
|
+
*/
|
|
13443
|
+
id: string;
|
|
13444
|
+
/** @description Product option. */
|
|
13445
|
+
option?: {
|
|
13446
|
+
/**
|
|
13447
|
+
* Format: uuid
|
|
13448
|
+
* @description Product option id.
|
|
13449
|
+
*/
|
|
13450
|
+
id: string;
|
|
13451
|
+
/** @description Product option title. */
|
|
13452
|
+
title: string;
|
|
13453
|
+
};
|
|
13454
|
+
/** @description Product title. */
|
|
13455
|
+
title: string;
|
|
13456
|
+
};
|
|
13457
|
+
/** @description Quantity of units. */
|
|
13458
|
+
quantity: number;
|
|
13459
|
+
}[];
|
|
13460
|
+
};
|
|
13461
|
+
/**
|
|
13462
|
+
* @deprecated
|
|
13463
|
+
* @description Deprecated. Use amounts instead.
|
|
13464
|
+
*/
|
|
13465
|
+
permanentAmount?: number;
|
|
13466
|
+
/** @description Product details. */
|
|
13467
|
+
product?: {
|
|
13468
|
+
/**
|
|
13469
|
+
* Format: uuid
|
|
13470
|
+
* @description ID of the associated booking.
|
|
13471
|
+
*/
|
|
13472
|
+
bookingRef?: string;
|
|
13473
|
+
/**
|
|
13474
|
+
* Format: uuid
|
|
13475
|
+
* @description ID of the associated event ticket.
|
|
13476
|
+
*/
|
|
13477
|
+
eventTicketRef?: string;
|
|
13478
|
+
/**
|
|
13479
|
+
* Format: uuid
|
|
13480
|
+
* @description ID of the associated order.
|
|
13481
|
+
*/
|
|
13482
|
+
orderRef?: string;
|
|
13483
|
+
/** @description Display title of the product. */
|
|
13484
|
+
title?: string;
|
|
13485
|
+
/**
|
|
13486
|
+
* @description Product type.
|
|
13487
|
+
* @enum {string}
|
|
13488
|
+
*/
|
|
13489
|
+
type?: "booking" | "eventTicket" | "order";
|
|
13490
|
+
};
|
|
13491
|
+
/**
|
|
13492
|
+
* @deprecated
|
|
13493
|
+
* @description Deprecated.
|
|
13494
|
+
*/
|
|
13495
|
+
refund?: {
|
|
13496
|
+
/** @description Refunded amount. */
|
|
13497
|
+
amount: number;
|
|
13498
|
+
/**
|
|
13499
|
+
* Format: date-time
|
|
13500
|
+
* @description Refund creation timestamp.
|
|
13501
|
+
*/
|
|
13502
|
+
createDate: string;
|
|
13503
|
+
};
|
|
13504
|
+
/** @description Transaction status. */
|
|
13505
|
+
status: string;
|
|
13506
|
+
/**
|
|
13507
|
+
* @deprecated
|
|
13508
|
+
* @description Deprecated. Use product instead.
|
|
13509
|
+
*/
|
|
13510
|
+
ticket?: {
|
|
13511
|
+
/**
|
|
13512
|
+
* Format: date-time
|
|
13513
|
+
* @description Ticket creation timestamp.
|
|
13514
|
+
*/
|
|
13515
|
+
createDate?: string;
|
|
13516
|
+
/** @description Event details. */
|
|
13517
|
+
event?: {
|
|
13518
|
+
/**
|
|
13519
|
+
* Format: date-time
|
|
13520
|
+
* @description Event end date.
|
|
13521
|
+
*/
|
|
13522
|
+
endDate?: string;
|
|
13523
|
+
/**
|
|
13524
|
+
* Format: uuid
|
|
13525
|
+
* @description Event id.
|
|
13526
|
+
*/
|
|
13527
|
+
id: string;
|
|
13528
|
+
/**
|
|
13529
|
+
* Format: date-time
|
|
13530
|
+
* @description Event start date.
|
|
13531
|
+
*/
|
|
13532
|
+
startDate?: string;
|
|
13533
|
+
/** @description Event title. */
|
|
13534
|
+
title: string;
|
|
13535
|
+
};
|
|
13536
|
+
/**
|
|
13537
|
+
* Format: uuid
|
|
13538
|
+
* @description Ticket id.
|
|
13539
|
+
*/
|
|
13540
|
+
id: string;
|
|
13541
|
+
/** @description Number of tickets. */
|
|
13542
|
+
quantity: number;
|
|
13543
|
+
};
|
|
13544
|
+
/**
|
|
13545
|
+
* @description Credits transaction type.
|
|
13546
|
+
* @enum {string}
|
|
13547
|
+
*/
|
|
13548
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "eventTicket" | "expiration" | "order" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
13549
|
+
/** @description User who created the transaction. */
|
|
13550
|
+
userCreatedBy?: {
|
|
13551
|
+
about?: string | null;
|
|
13552
|
+
email?: string | null;
|
|
13553
|
+
/** Format: uuid */
|
|
13554
|
+
id: string;
|
|
13555
|
+
name?: string | null;
|
|
13556
|
+
phoneNumber?: string | null;
|
|
13557
|
+
photoUrl?: string | null;
|
|
13558
|
+
surname?: string | null;
|
|
13559
|
+
};
|
|
13560
|
+
/**
|
|
13561
|
+
* @deprecated
|
|
13562
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13563
|
+
*/
|
|
13564
|
+
userCreator?: {
|
|
13565
|
+
about?: string | null;
|
|
13566
|
+
email?: string | null;
|
|
13567
|
+
/** Format: uuid */
|
|
13568
|
+
id: string;
|
|
13569
|
+
name?: string | null;
|
|
13570
|
+
phoneNumber?: string | null;
|
|
13571
|
+
photoUrl?: string | null;
|
|
13572
|
+
surname?: string | null;
|
|
13573
|
+
};
|
|
13574
|
+
/**
|
|
13575
|
+
* @deprecated
|
|
13576
|
+
* @description Deprecated. Use customer.user instead.
|
|
13577
|
+
*/
|
|
13578
|
+
userOwner?: {
|
|
13579
|
+
about?: string | null;
|
|
13580
|
+
email?: string | null;
|
|
13581
|
+
/** Format: uuid */
|
|
13582
|
+
id: string;
|
|
13583
|
+
name?: string | null;
|
|
13584
|
+
phoneNumber?: string | null;
|
|
13585
|
+
photoUrl?: string | null;
|
|
13586
|
+
surname?: string | null;
|
|
13587
|
+
};
|
|
13588
|
+
/**
|
|
13589
|
+
* Format: uuid
|
|
13590
|
+
* @deprecated
|
|
13591
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13592
|
+
*/
|
|
13593
|
+
userRefCreator?: string;
|
|
13594
|
+
/**
|
|
13595
|
+
* Format: uuid
|
|
13596
|
+
* @deprecated
|
|
13597
|
+
* @description Deprecated. Use customer.user instead.
|
|
13598
|
+
*/
|
|
13599
|
+
userRefOwner?: string;
|
|
13600
|
+
};
|
|
13601
|
+
};
|
|
13602
|
+
transactionCredits: {
|
|
13603
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
13604
|
+
amount: number;
|
|
13605
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
13606
|
+
amounts: {
|
|
13607
|
+
/** @description Amount deducted from this balance bucket. */
|
|
13608
|
+
amount: number;
|
|
13609
|
+
/**
|
|
13610
|
+
* Format: date-time
|
|
13611
|
+
* @description Expiration date for expiring balances.
|
|
13612
|
+
*/
|
|
13613
|
+
expirationDate?: string;
|
|
13614
|
+
/**
|
|
13615
|
+
* Format: uuid
|
|
13616
|
+
* @description Subscription associated with expiring balances.
|
|
13617
|
+
*/
|
|
13618
|
+
subscriptionRef?: string;
|
|
13619
|
+
/**
|
|
13620
|
+
* @description Balance bucket type.
|
|
13621
|
+
* @enum {string}
|
|
13622
|
+
*/
|
|
13623
|
+
type: "expiring" | "permanent";
|
|
13624
|
+
}[];
|
|
13625
|
+
/**
|
|
13626
|
+
* @deprecated
|
|
13627
|
+
* @description Deprecated. Use product instead.
|
|
13628
|
+
*/
|
|
13629
|
+
booking?: {
|
|
13630
|
+
/**
|
|
13631
|
+
* Format: date-time
|
|
13632
|
+
* @description Booking end date.
|
|
13633
|
+
*/
|
|
13634
|
+
endDate?: string;
|
|
13635
|
+
/**
|
|
13636
|
+
* Format: uuid
|
|
13637
|
+
* @description Booking id.
|
|
13638
|
+
*/
|
|
13639
|
+
id: string;
|
|
13640
|
+
/** @description Booked resource. */
|
|
13641
|
+
resource: {
|
|
13642
|
+
/**
|
|
13643
|
+
* Format: uuid
|
|
13644
|
+
* @description Resource id.
|
|
13645
|
+
*/
|
|
13646
|
+
id: string;
|
|
13647
|
+
/** @description Resource title. */
|
|
13648
|
+
title: string;
|
|
13649
|
+
};
|
|
13650
|
+
/**
|
|
13651
|
+
* Format: date-time
|
|
13652
|
+
* @description Booking start date.
|
|
13653
|
+
*/
|
|
13654
|
+
startDate?: string;
|
|
13655
|
+
};
|
|
13656
|
+
/**
|
|
13657
|
+
* @deprecated
|
|
13658
|
+
* @description Deprecated. Use customer instead.
|
|
13659
|
+
*/
|
|
13660
|
+
company?: {
|
|
13661
|
+
/**
|
|
13662
|
+
* Format: date-time
|
|
13663
|
+
* @description ISO timestamp of company creation.
|
|
13664
|
+
*/
|
|
13665
|
+
createDate: string;
|
|
13666
|
+
/**
|
|
13667
|
+
* Format: uuid
|
|
13668
|
+
* @description Company id.
|
|
13669
|
+
*/
|
|
13670
|
+
id: string;
|
|
13671
|
+
/**
|
|
13672
|
+
* Format: uuid
|
|
13673
|
+
* @description Location id.
|
|
13674
|
+
*/
|
|
13675
|
+
locationRef: string;
|
|
13676
|
+
/** @description Company logo. */
|
|
13677
|
+
logo?: {
|
|
13678
|
+
/** @description Storage key of the company logo. */
|
|
13679
|
+
key: string;
|
|
13680
|
+
/** @description Public URL of the company logo. */
|
|
13681
|
+
url: string;
|
|
13682
|
+
};
|
|
13683
|
+
/** @description Company metadata. */
|
|
13684
|
+
metadata?: {
|
|
13685
|
+
[key: string]: unknown;
|
|
13686
|
+
};
|
|
13687
|
+
/** @description Internal notes. */
|
|
13688
|
+
notes?: string;
|
|
13689
|
+
/** @description Public logo URL derived from the company website. */
|
|
13690
|
+
publicLogoUrl?: string;
|
|
13691
|
+
/**
|
|
13692
|
+
* Format: uuid
|
|
13693
|
+
* @description Primary subscription id.
|
|
13694
|
+
*/
|
|
13695
|
+
subscriptionRef: string | null;
|
|
13696
|
+
/** @description Company name. */
|
|
13697
|
+
title: string;
|
|
13698
|
+
};
|
|
13699
|
+
/**
|
|
13700
|
+
* Format: uuid
|
|
13701
|
+
* @deprecated
|
|
13702
|
+
* @description Deprecated. Use customer instead.
|
|
13703
|
+
*/
|
|
13704
|
+
companyRef?: string;
|
|
13705
|
+
/**
|
|
13706
|
+
* Format: date-time
|
|
13707
|
+
* @description ISO timestamp of when the transaction was created.
|
|
13708
|
+
*/
|
|
13709
|
+
createDate: string;
|
|
13710
|
+
/** @description Customer associated with this transaction. */
|
|
13711
|
+
customer: {
|
|
13712
|
+
/**
|
|
13713
|
+
* Format: uuid
|
|
13714
|
+
* @description ID of the company or membership.
|
|
13715
|
+
*/
|
|
13716
|
+
id: string;
|
|
13717
|
+
/** @description Company logo. */
|
|
13718
|
+
logo?: {
|
|
13719
|
+
key: string;
|
|
13720
|
+
url: string;
|
|
13721
|
+
};
|
|
13722
|
+
/** @description Company name. */
|
|
13723
|
+
title?: string;
|
|
13724
|
+
/**
|
|
13725
|
+
* @description Whether the customer is a company or a user.
|
|
13726
|
+
* @enum {string}
|
|
13727
|
+
*/
|
|
13728
|
+
type: "company" | "user";
|
|
13729
|
+
/** @description User details for membership customers. */
|
|
13730
|
+
user?: {
|
|
13731
|
+
about?: string | null;
|
|
13732
|
+
email?: string | null;
|
|
13733
|
+
/** Format: uuid */
|
|
13734
|
+
id: string;
|
|
13735
|
+
name?: string | null;
|
|
13736
|
+
phoneNumber?: string | null;
|
|
13737
|
+
photoUrl?: string | null;
|
|
13738
|
+
surname?: string | null;
|
|
13739
|
+
};
|
|
13740
|
+
};
|
|
13741
|
+
/** @description Transaction description. */
|
|
13742
|
+
description?: string;
|
|
13743
|
+
/** @description Discounts applied to the transaction. */
|
|
13744
|
+
discounts?: {
|
|
13745
|
+
/** @description Applied coupon. */
|
|
13746
|
+
coupon: {
|
|
13747
|
+
/** @description Fixed amount discount. */
|
|
13748
|
+
amountOff?: number;
|
|
13749
|
+
/** @description Currency of the fixed amount discount. */
|
|
13750
|
+
currencyCode?: string;
|
|
13751
|
+
/** @description Coupon id. */
|
|
13752
|
+
id: string;
|
|
13753
|
+
/** @description Percentage discount. */
|
|
13754
|
+
percentOff?: number;
|
|
13755
|
+
/** @description Product types the coupon applies to. */
|
|
13756
|
+
productTypes?: string[];
|
|
13757
|
+
/** @description Coupon type. */
|
|
13758
|
+
type: string;
|
|
13759
|
+
};
|
|
13760
|
+
/** @description Promocode the coupon was applied with. */
|
|
13761
|
+
promocode?: {
|
|
13762
|
+
/** @description Promocode. */
|
|
13763
|
+
code: string;
|
|
13764
|
+
/** @description Promocode expiration date. */
|
|
13765
|
+
expiration?: string;
|
|
13766
|
+
/**
|
|
13767
|
+
* Format: uuid
|
|
13768
|
+
* @description Promocode id.
|
|
13769
|
+
*/
|
|
13770
|
+
id: string;
|
|
13771
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
13772
|
+
limitByFirstPurchase?: boolean;
|
|
13773
|
+
};
|
|
13774
|
+
/**
|
|
13775
|
+
* Format: uuid
|
|
13776
|
+
* @description ID of the subscription this discount is associated with.
|
|
13777
|
+
*/
|
|
13778
|
+
subscriptionId?: string;
|
|
13779
|
+
}[];
|
|
13780
|
+
/**
|
|
13781
|
+
* @deprecated
|
|
13782
|
+
* @description Deprecated. Use amounts instead.
|
|
13783
|
+
*/
|
|
13784
|
+
expiringAmount?: number;
|
|
13785
|
+
/**
|
|
13786
|
+
* Format: uuid
|
|
13787
|
+
* @description Unique identifier of the transaction.
|
|
13788
|
+
*/
|
|
13789
|
+
id: string;
|
|
13790
|
+
/**
|
|
13791
|
+
* Format: uuid
|
|
13792
|
+
* @description ID of the organization (location).
|
|
13793
|
+
*/
|
|
13794
|
+
locationRef: string;
|
|
13795
|
+
/**
|
|
13796
|
+
* Format: uuid
|
|
13797
|
+
* @deprecated
|
|
13798
|
+
* @description Deprecated. Use customer instead.
|
|
13799
|
+
*/
|
|
13800
|
+
membershipRef?: string;
|
|
13801
|
+
/**
|
|
13802
|
+
* Format: uuid
|
|
13803
|
+
* @deprecated
|
|
13804
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13805
|
+
*/
|
|
13806
|
+
membershipRefCreator?: string;
|
|
13807
|
+
/**
|
|
13808
|
+
* Format: uuid
|
|
13809
|
+
* @description ID of the network.
|
|
13810
|
+
*/
|
|
13811
|
+
networkRef: string;
|
|
13812
|
+
/**
|
|
13813
|
+
* @deprecated
|
|
13814
|
+
* @description Deprecated. Use product instead.
|
|
13815
|
+
*/
|
|
13816
|
+
order?: {
|
|
13817
|
+
/**
|
|
13818
|
+
* Format: uuid
|
|
13819
|
+
* @description Order id.
|
|
13820
|
+
*/
|
|
13821
|
+
id: string;
|
|
13822
|
+
/** @description Order items. */
|
|
13823
|
+
items: {
|
|
13824
|
+
/**
|
|
13825
|
+
* Format: uuid
|
|
13826
|
+
* @description Order item id.
|
|
13827
|
+
*/
|
|
13828
|
+
id: string;
|
|
13829
|
+
/** @description Ordered product. */
|
|
13830
|
+
product: {
|
|
13831
|
+
/**
|
|
13832
|
+
* Format: uuid
|
|
13833
|
+
* @description Product id.
|
|
13834
|
+
*/
|
|
13835
|
+
id: string;
|
|
13836
|
+
/** @description Product option. */
|
|
13837
|
+
option?: {
|
|
13838
|
+
/**
|
|
13839
|
+
* Format: uuid
|
|
13840
|
+
* @description Product option id.
|
|
13841
|
+
*/
|
|
13842
|
+
id: string;
|
|
13843
|
+
/** @description Product option title. */
|
|
13844
|
+
title: string;
|
|
13845
|
+
};
|
|
13846
|
+
/** @description Product title. */
|
|
13847
|
+
title: string;
|
|
13848
|
+
};
|
|
13849
|
+
/** @description Quantity of units. */
|
|
13850
|
+
quantity: number;
|
|
13851
|
+
}[];
|
|
13852
|
+
};
|
|
13853
|
+
/**
|
|
13854
|
+
* @deprecated
|
|
13855
|
+
* @description Deprecated. Use amounts instead.
|
|
13856
|
+
*/
|
|
13857
|
+
permanentAmount?: number;
|
|
13858
|
+
/** @description Product details. */
|
|
13859
|
+
product?: {
|
|
13860
|
+
/**
|
|
13861
|
+
* Format: uuid
|
|
13862
|
+
* @description ID of the associated booking.
|
|
13863
|
+
*/
|
|
13864
|
+
bookingRef?: string;
|
|
13865
|
+
/**
|
|
13866
|
+
* Format: uuid
|
|
13867
|
+
* @description ID of the associated event ticket.
|
|
13868
|
+
*/
|
|
13869
|
+
eventTicketRef?: string;
|
|
13870
|
+
/**
|
|
13871
|
+
* Format: uuid
|
|
13872
|
+
* @description ID of the associated order.
|
|
13873
|
+
*/
|
|
13874
|
+
orderRef?: string;
|
|
13875
|
+
/** @description Display title of the product. */
|
|
13876
|
+
title?: string;
|
|
13877
|
+
/**
|
|
13878
|
+
* @description Product type.
|
|
13879
|
+
* @enum {string}
|
|
13880
|
+
*/
|
|
13881
|
+
type?: "booking" | "eventTicket" | "order";
|
|
13882
|
+
};
|
|
13883
|
+
/**
|
|
13884
|
+
* @deprecated
|
|
13885
|
+
* @description Deprecated.
|
|
13886
|
+
*/
|
|
13887
|
+
refund?: {
|
|
13888
|
+
/** @description Refunded amount. */
|
|
13889
|
+
amount: number;
|
|
13890
|
+
/**
|
|
13891
|
+
* Format: date-time
|
|
13892
|
+
* @description Refund creation timestamp.
|
|
13893
|
+
*/
|
|
13894
|
+
createDate: string;
|
|
13895
|
+
};
|
|
13896
|
+
/** @description Transaction status. */
|
|
13897
|
+
status: string;
|
|
13898
|
+
/**
|
|
13899
|
+
* @deprecated
|
|
13900
|
+
* @description Deprecated. Use product instead.
|
|
13901
|
+
*/
|
|
13902
|
+
ticket?: {
|
|
13903
|
+
/**
|
|
13904
|
+
* Format: date-time
|
|
13905
|
+
* @description Ticket creation timestamp.
|
|
13906
|
+
*/
|
|
13907
|
+
createDate?: string;
|
|
13908
|
+
/** @description Event details. */
|
|
13909
|
+
event?: {
|
|
13910
|
+
/**
|
|
13911
|
+
* Format: date-time
|
|
13912
|
+
* @description Event end date.
|
|
13913
|
+
*/
|
|
13914
|
+
endDate?: string;
|
|
13915
|
+
/**
|
|
13916
|
+
* Format: uuid
|
|
13917
|
+
* @description Event id.
|
|
13918
|
+
*/
|
|
13919
|
+
id: string;
|
|
13920
|
+
/**
|
|
13921
|
+
* Format: date-time
|
|
13922
|
+
* @description Event start date.
|
|
13923
|
+
*/
|
|
13924
|
+
startDate?: string;
|
|
13925
|
+
/** @description Event title. */
|
|
13926
|
+
title: string;
|
|
13927
|
+
};
|
|
13928
|
+
/**
|
|
13929
|
+
* Format: uuid
|
|
13930
|
+
* @description Ticket id.
|
|
13931
|
+
*/
|
|
13932
|
+
id: string;
|
|
13933
|
+
/** @description Number of tickets. */
|
|
13934
|
+
quantity: number;
|
|
13935
|
+
};
|
|
13936
|
+
/**
|
|
13937
|
+
* @description Credits transaction type.
|
|
13938
|
+
* @enum {string}
|
|
13939
|
+
*/
|
|
13940
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "eventTicket" | "expiration" | "order" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
13941
|
+
/** @description User who created the transaction. */
|
|
13942
|
+
userCreatedBy?: {
|
|
13943
|
+
about?: string | null;
|
|
13944
|
+
email?: string | null;
|
|
13945
|
+
/** Format: uuid */
|
|
13946
|
+
id: string;
|
|
13947
|
+
name?: string | null;
|
|
13948
|
+
phoneNumber?: string | null;
|
|
13949
|
+
photoUrl?: string | null;
|
|
13950
|
+
surname?: string | null;
|
|
13951
|
+
};
|
|
13952
|
+
/**
|
|
13953
|
+
* @deprecated
|
|
13954
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13955
|
+
*/
|
|
13956
|
+
userCreator?: {
|
|
13957
|
+
about?: string | null;
|
|
13958
|
+
email?: string | null;
|
|
13959
|
+
/** Format: uuid */
|
|
13960
|
+
id: string;
|
|
13961
|
+
name?: string | null;
|
|
13962
|
+
phoneNumber?: string | null;
|
|
13963
|
+
photoUrl?: string | null;
|
|
13964
|
+
surname?: string | null;
|
|
12469
13965
|
};
|
|
12470
|
-
|
|
12471
|
-
|
|
12472
|
-
|
|
12473
|
-
|
|
12474
|
-
|
|
12475
|
-
|
|
12476
|
-
|
|
12477
|
-
ticket?: {
|
|
12478
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
12479
|
-
event?: {
|
|
12480
|
-
endDate?: components["schemas"]["dateSchema"];
|
|
12481
|
-
/** Format: uuid */
|
|
12482
|
-
id?: string;
|
|
12483
|
-
startDate?: components["schemas"]["dateSchema"];
|
|
12484
|
-
title?: string;
|
|
12485
|
-
};
|
|
13966
|
+
/**
|
|
13967
|
+
* @deprecated
|
|
13968
|
+
* @description Deprecated. Use customer.user instead.
|
|
13969
|
+
*/
|
|
13970
|
+
userOwner?: {
|
|
13971
|
+
about?: string | null;
|
|
13972
|
+
email?: string | null;
|
|
12486
13973
|
/** Format: uuid */
|
|
12487
|
-
id
|
|
13974
|
+
id: string;
|
|
13975
|
+
name?: string | null;
|
|
13976
|
+
phoneNumber?: string | null;
|
|
13977
|
+
photoUrl?: string | null;
|
|
13978
|
+
surname?: string | null;
|
|
12488
13979
|
};
|
|
12489
|
-
/**
|
|
12490
|
-
|
|
12491
|
-
|
|
12492
|
-
|
|
12493
|
-
|
|
13980
|
+
/**
|
|
13981
|
+
* Format: uuid
|
|
13982
|
+
* @deprecated
|
|
13983
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13984
|
+
*/
|
|
12494
13985
|
userRefCreator?: string;
|
|
12495
|
-
/**
|
|
13986
|
+
/**
|
|
13987
|
+
* Format: uuid
|
|
13988
|
+
* @deprecated
|
|
13989
|
+
* @description Deprecated. Use customer.user instead.
|
|
13990
|
+
*/
|
|
12496
13991
|
userRefOwner?: string;
|
|
12497
13992
|
};
|
|
12498
|
-
transactionCredits: {
|
|
12499
|
-
amount?: number;
|
|
12500
|
-
company?: components["schemas"]["company"];
|
|
12501
|
-
/** Format: uuid */
|
|
12502
|
-
companyRef?: string;
|
|
12503
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
12504
|
-
/** @description The memo of the transaction. */
|
|
12505
|
-
description?: string;
|
|
12506
|
-
/** Format: uuid */
|
|
12507
|
-
id?: string;
|
|
12508
|
-
/** Format: uuid */
|
|
12509
|
-
locationRef?: string;
|
|
12510
|
-
/** Format: uuid */
|
|
12511
|
-
membershipRef?: string;
|
|
12512
|
-
/** Format: uuid */
|
|
12513
|
-
membershipRefCreator?: string;
|
|
12514
|
-
/** @enum {string} */
|
|
12515
|
-
status?: "canceled" | "failed" | "succeeded";
|
|
12516
|
-
/** @enum {string} */
|
|
12517
|
-
type?: "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
12518
|
-
userCreator?: components["schemas"]["user"];
|
|
12519
|
-
userOwner?: components["schemas"]["user"];
|
|
12520
|
-
/** Format: uuid */
|
|
12521
|
-
userRef?: string;
|
|
12522
|
-
/** Format: uuid */
|
|
12523
|
-
userRefCreator?: string;
|
|
12524
|
-
};
|
|
12525
13993
|
getScheduledDayPassesTransactions: {
|
|
12526
13994
|
/** @description Pagination token to fetch the next page of results. Returned when more results exist. */
|
|
12527
13995
|
nextPageToken?: string;
|
|
@@ -12768,6 +14236,8 @@ interface components {
|
|
|
12768
14236
|
getDayPassesTransactions: {
|
|
12769
14237
|
/** @description Pagination token to fetch the next page of results. */
|
|
12770
14238
|
nextPageToken?: string;
|
|
14239
|
+
/** @description Ready-to-use query string with the current filters and nextPageToken to fetch the next page of results. */
|
|
14240
|
+
searchQueryNext?: string;
|
|
12771
14241
|
/** @description List of day pass transactions. */
|
|
12772
14242
|
transactions: {
|
|
12773
14243
|
/** @description Total day pass amount (absolute sum of expiring and permanent). */
|
|
@@ -16296,6 +17766,8 @@ interface components {
|
|
|
16296
17766
|
* @description The id of membership owner.
|
|
16297
17767
|
*/
|
|
16298
17768
|
membershipRefOwner?: string;
|
|
17769
|
+
/** @description Number of seats to reserve. Required for desk and office resources. */
|
|
17770
|
+
seats?: number;
|
|
16299
17771
|
};
|
|
16300
17772
|
};
|
|
16301
17773
|
};
|
|
@@ -17413,28 +18885,42 @@ interface components {
|
|
|
17413
18885
|
createCreditsTransaction: {
|
|
17414
18886
|
content: {
|
|
17415
18887
|
"application/json": {
|
|
18888
|
+
/** @description Credits transaction to create. */
|
|
17416
18889
|
transaction: {
|
|
18890
|
+
/** @description Credits amount. Must be greater than zero. */
|
|
17417
18891
|
amount: number;
|
|
17418
18892
|
/**
|
|
17419
18893
|
* Format: uuid
|
|
17420
|
-
* @
|
|
18894
|
+
* @deprecated
|
|
18895
|
+
* @description Deprecated. Use customerRef instead.
|
|
17421
18896
|
*/
|
|
17422
18897
|
companyRef?: string;
|
|
17423
|
-
/**
|
|
18898
|
+
/**
|
|
18899
|
+
* Format: uuid
|
|
18900
|
+
* @description The company or membership id to charge or transfer credits to or from.
|
|
18901
|
+
*/
|
|
18902
|
+
customerRef?: string;
|
|
18903
|
+
/** @description Description of the transaction. */
|
|
17424
18904
|
description?: string;
|
|
18905
|
+
/** @description Expiration date for expiring credits. */
|
|
18906
|
+
expirationDate?: string;
|
|
17425
18907
|
/**
|
|
17426
18908
|
* Format: uuid
|
|
17427
|
-
* @description The location id where to create
|
|
18909
|
+
* @description The location id where to create the transaction.
|
|
17428
18910
|
*/
|
|
17429
18911
|
locationRef: string;
|
|
17430
18912
|
/**
|
|
17431
18913
|
* Format: uuid
|
|
17432
|
-
* @
|
|
18914
|
+
* @deprecated
|
|
18915
|
+
* @description Deprecated. Use customerRef instead.
|
|
17433
18916
|
*/
|
|
17434
18917
|
membershipRef?: string;
|
|
17435
|
-
/**
|
|
17436
|
-
|
|
17437
|
-
|
|
18918
|
+
/**
|
|
18919
|
+
* @description Transaction type. chargeExpiringCredits, chargePermanentCredits, transferExpiringCredits, and transferPermanentCredits are deprecated; use adminCharge or adminAllocation instead.
|
|
18920
|
+
* @enum {string}
|
|
18921
|
+
*/
|
|
18922
|
+
type: "adminAllocation" | "adminCharge" | "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
18923
|
+
};
|
|
17438
18924
|
};
|
|
17439
18925
|
};
|
|
17440
18926
|
};
|
|
@@ -20867,13 +22353,29 @@ interface operations {
|
|
|
20867
22353
|
};
|
|
20868
22354
|
getEventTickets: {
|
|
20869
22355
|
parameters: {
|
|
20870
|
-
query
|
|
20871
|
-
/** @description
|
|
20872
|
-
|
|
20873
|
-
/** @description
|
|
22356
|
+
query?: {
|
|
22357
|
+
/** @description UUID of the customer whose event tickets to list. */
|
|
22358
|
+
customerRef?: string;
|
|
22359
|
+
/** @description UUID of the event whose tickets to list. */
|
|
22360
|
+
eventRef?: string;
|
|
22361
|
+
/** @description Deprecated. Use status "canceled" instead. Set to "true" to include deleted event tickets. */
|
|
22362
|
+
includeDeleted?: string;
|
|
22363
|
+
/** @description Maximum number of event tickets per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
20874
22364
|
limit?: number;
|
|
20875
|
-
/** @description
|
|
20876
|
-
|
|
22365
|
+
/** @description UUID of the location whose event tickets to list. */
|
|
22366
|
+
locationRef?: string;
|
|
22367
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
22368
|
+
nextPageToken?: string;
|
|
22369
|
+
/**
|
|
22370
|
+
* @description Filter by event ticket status. Comma-separated values, e.g. `active,canceled`. Defaults to `active` when omitted.
|
|
22371
|
+
*
|
|
22372
|
+
* Supported values:
|
|
22373
|
+
* - **active** — the ticket is valid
|
|
22374
|
+
* - **canceled** — the ticket was deleted
|
|
22375
|
+
*/
|
|
22376
|
+
status?: string;
|
|
22377
|
+
/** @description UUID of the user whose event tickets to list. */
|
|
22378
|
+
userRef?: string;
|
|
20877
22379
|
};
|
|
20878
22380
|
header?: {
|
|
20879
22381
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -23757,32 +25259,70 @@ interface operations {
|
|
|
23757
25259
|
};
|
|
23758
25260
|
};
|
|
23759
25261
|
};
|
|
23760
|
-
|
|
25262
|
+
getScheduledCreditsTransactions: {
|
|
23761
25263
|
parameters: {
|
|
23762
25264
|
query?: {
|
|
23763
|
-
/** @description
|
|
25265
|
+
/** @description UUID of the company or membership whose scheduled credits transactions to list. */
|
|
25266
|
+
customerRef?: string;
|
|
25267
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
23764
25268
|
limit?: number;
|
|
23765
25269
|
/** @description Token to retrieve the next page of results. */
|
|
23766
|
-
nextPageToken?:
|
|
23767
|
-
/** @description
|
|
23768
|
-
|
|
23769
|
-
|
|
23770
|
-
|
|
23771
|
-
|
|
23772
|
-
|
|
23773
|
-
|
|
23774
|
-
|
|
23775
|
-
|
|
23776
|
-
|
|
23777
|
-
|
|
23778
|
-
|
|
25270
|
+
nextPageToken?: string;
|
|
25271
|
+
/** @description UUID of the subscription whose scheduled credits transactions to list. */
|
|
25272
|
+
subscriptionRef?: string;
|
|
25273
|
+
};
|
|
25274
|
+
header?: {
|
|
25275
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25276
|
+
"spacebring-network-id"?: string;
|
|
25277
|
+
};
|
|
25278
|
+
path?: never;
|
|
25279
|
+
cookie?: never;
|
|
25280
|
+
};
|
|
25281
|
+
requestBody?: never;
|
|
25282
|
+
responses: {
|
|
25283
|
+
/** @description OK */
|
|
25284
|
+
200: {
|
|
25285
|
+
headers: {
|
|
25286
|
+
[name: string]: unknown;
|
|
25287
|
+
};
|
|
25288
|
+
content: {
|
|
25289
|
+
"application/json": components["schemas"]["getScheduledCreditsTransactions"];
|
|
25290
|
+
};
|
|
25291
|
+
};
|
|
25292
|
+
/** @description Bad Request */
|
|
25293
|
+
400: {
|
|
25294
|
+
headers: {
|
|
25295
|
+
[name: string]: unknown;
|
|
25296
|
+
};
|
|
25297
|
+
content: {
|
|
25298
|
+
"application/json": components["schemas"]["responseError"];
|
|
23779
25299
|
};
|
|
23780
|
-
|
|
25300
|
+
};
|
|
25301
|
+
};
|
|
25302
|
+
};
|
|
25303
|
+
getCreditsTransactions: {
|
|
25304
|
+
parameters: {
|
|
25305
|
+
query?: {
|
|
25306
|
+
/** @description Deprecated. Use customerRef instead. The id of the company to get transactions for. */
|
|
25307
|
+
companyRef?: string;
|
|
25308
|
+
/** @description Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
25309
|
+
"createDate[gte]"?: string;
|
|
25310
|
+
/** @description Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
25311
|
+
"createDate[lte]"?: string;
|
|
25312
|
+
/** @description UUID of the company or membership whose credits transactions to list. */
|
|
25313
|
+
customerRef?: string;
|
|
25314
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
25315
|
+
limit?: number;
|
|
25316
|
+
/** @description UUID of the location whose credits transactions to list. */
|
|
23781
25317
|
locationRef?: string;
|
|
23782
|
-
/** @description The id of the membership to get transactions for */
|
|
25318
|
+
/** @description Deprecated. Use customerRef instead. The id of the membership to get transactions for. */
|
|
23783
25319
|
membershipRef?: string;
|
|
23784
|
-
/** @description
|
|
23785
|
-
|
|
25320
|
+
/** @description Token to retrieve the next page of results. */
|
|
25321
|
+
nextPageToken?: string;
|
|
25322
|
+
/** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
25323
|
+
status?: string;
|
|
25324
|
+
/** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
|
|
25325
|
+
type?: string;
|
|
23786
25326
|
};
|
|
23787
25327
|
header?: {
|
|
23788
25328
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -23799,10 +25339,7 @@ interface operations {
|
|
|
23799
25339
|
[name: string]: unknown;
|
|
23800
25340
|
};
|
|
23801
25341
|
content: {
|
|
23802
|
-
"application/json":
|
|
23803
|
-
transactions?: components["schemas"]["transactionCreditsExpanded"][];
|
|
23804
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
23805
|
-
};
|
|
25342
|
+
"application/json": components["schemas"]["getCreditsTransactions"];
|
|
23806
25343
|
};
|
|
23807
25344
|
};
|
|
23808
25345
|
/** @description Bad Request */
|
|
@@ -23830,6 +25367,41 @@ interface operations {
|
|
|
23830
25367
|
responses: {
|
|
23831
25368
|
/** @description Created */
|
|
23832
25369
|
201: {
|
|
25370
|
+
headers: {
|
|
25371
|
+
[name: string]: unknown;
|
|
25372
|
+
};
|
|
25373
|
+
content: {
|
|
25374
|
+
"application/json": components["schemas"]["createCreditsTransaction"];
|
|
25375
|
+
};
|
|
25376
|
+
};
|
|
25377
|
+
/** @description Bad Request */
|
|
25378
|
+
400: {
|
|
25379
|
+
headers: {
|
|
25380
|
+
[name: string]: unknown;
|
|
25381
|
+
};
|
|
25382
|
+
content: {
|
|
25383
|
+
"application/json": components["schemas"]["responseError"];
|
|
25384
|
+
};
|
|
25385
|
+
};
|
|
25386
|
+
};
|
|
25387
|
+
};
|
|
25388
|
+
getCreditsTransaction: {
|
|
25389
|
+
parameters: {
|
|
25390
|
+
query?: never;
|
|
25391
|
+
header?: {
|
|
25392
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
25393
|
+
"spacebring-network-id"?: string;
|
|
25394
|
+
};
|
|
25395
|
+
path: {
|
|
25396
|
+
/** @description The id of the transaction */
|
|
25397
|
+
id: string;
|
|
25398
|
+
};
|
|
25399
|
+
cookie?: never;
|
|
25400
|
+
};
|
|
25401
|
+
requestBody?: never;
|
|
25402
|
+
responses: {
|
|
25403
|
+
/** @description OK */
|
|
25404
|
+
200: {
|
|
23833
25405
|
headers: {
|
|
23834
25406
|
[name: string]: unknown;
|
|
23835
25407
|
};
|
|
@@ -24851,31 +26423,38 @@ type UpdateVisitBody = NonNullable<NonNullable<operations["updateVisit"]["reques
|
|
|
24851
26423
|
|
|
24852
26424
|
/** A Balance entity as returned by the Spacebring API. */
|
|
24853
26425
|
type Balance = NonNullable<components["schemas"]["balance"]>;
|
|
26426
|
+
/** A CreditScheduledTransaction entity as returned by the Spacebring API. */
|
|
26427
|
+
type CreditScheduledTransaction = NonNullable<operations["getScheduledCreditsTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
24854
26428
|
/** A CreditTransaction entity as returned by the Spacebring API. */
|
|
24855
|
-
type CreditTransaction = NonNullable<components["schemas"]["
|
|
26429
|
+
type CreditTransaction = NonNullable<components["schemas"]["transactionCredits"]>;
|
|
26430
|
+
/** A DayPassScheduledTransaction entity as returned by the Spacebring API. */
|
|
26431
|
+
type DayPassScheduledTransaction = NonNullable<operations["getScheduledDayPassesTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
24856
26432
|
/** A DayPassTransaction entity as returned by the Spacebring API. */
|
|
24857
26433
|
type DayPassTransaction = NonNullable<components["schemas"]["transactionDayPasses"]>;
|
|
24858
26434
|
/** A MoneyTransaction entity as returned by the Spacebring API. */
|
|
24859
26435
|
type MoneyTransaction = NonNullable<components["schemas"]["transaction"]>;
|
|
24860
|
-
/** A ScheduledTransaction entity as returned by the Spacebring API. */
|
|
24861
|
-
type ScheduledTransaction = NonNullable<operations["getScheduledDayPassesTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
24862
26436
|
/** Query parameters for `sb.transactions.credits.list()`. */
|
|
24863
26437
|
interface GetCreditsTransactionsQuery {
|
|
24864
|
-
/** The
|
|
26438
|
+
/** @deprecated Use customerRef instead. The id of the company to get transactions for. */
|
|
26439
|
+
companyRef?: string;
|
|
26440
|
+
/** Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
26441
|
+
"createDate[gte]"?: string;
|
|
26442
|
+
/** Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
26443
|
+
"createDate[lte]"?: string;
|
|
26444
|
+
/** UUID of the company or membership whose credits transactions to list. */
|
|
26445
|
+
customerRef?: string;
|
|
26446
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
24865
26447
|
limit?: number;
|
|
24866
|
-
/**
|
|
24867
|
-
nextPageToken?: string;
|
|
24868
|
-
/** The date filter of items. */
|
|
24869
|
-
createDate?: {
|
|
24870
|
-
lte?: string;
|
|
24871
|
-
gte?: string;
|
|
24872
|
-
};
|
|
24873
|
-
/** The id of the location to get transactions for */
|
|
26448
|
+
/** UUID of the location whose credits transactions to list. */
|
|
24874
26449
|
locationRef?: string;
|
|
24875
|
-
/** The id of the membership to get transactions for */
|
|
26450
|
+
/** @deprecated Use customerRef instead. The id of the membership to get transactions for. */
|
|
24876
26451
|
membershipRef?: string;
|
|
24877
|
-
/**
|
|
24878
|
-
|
|
26452
|
+
/** Token to retrieve the next page of results. */
|
|
26453
|
+
nextPageToken?: string;
|
|
26454
|
+
/** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
26455
|
+
status?: string;
|
|
26456
|
+
/** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
|
|
26457
|
+
type?: string;
|
|
24879
26458
|
}
|
|
24880
26459
|
/** Query parameters for `sb.transactions.dayPasses.list()`. */
|
|
24881
26460
|
interface GetDayPassesTransactionsQuery {
|
|
@@ -24916,6 +26495,17 @@ interface GetMoneyTransactionsQuery {
|
|
|
24916
26495
|
/** Token to retrieve the next page of results. */
|
|
24917
26496
|
nextPageToken?: string;
|
|
24918
26497
|
}
|
|
26498
|
+
/** Query parameters for `sb.transactions.credits.scheduled.list()`. */
|
|
26499
|
+
interface GetScheduledCreditsTransactionsQuery {
|
|
26500
|
+
/** UUID of the company or membership whose scheduled credits transactions to list. */
|
|
26501
|
+
customerRef?: string;
|
|
26502
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
26503
|
+
limit?: number;
|
|
26504
|
+
/** Token to retrieve the next page of results. */
|
|
26505
|
+
nextPageToken?: string;
|
|
26506
|
+
/** UUID of the subscription whose scheduled credits transactions to list. */
|
|
26507
|
+
subscriptionRef?: string;
|
|
26508
|
+
}
|
|
24919
26509
|
/** Query parameters for `sb.transactions.dayPasses.scheduled.list()`. */
|
|
24920
26510
|
interface GetScheduledDayPassesTransactionsQuery {
|
|
24921
26511
|
/** UUID of the company or membership whose scheduled day pass transactions to list. */
|
|
@@ -25240,12 +26830,26 @@ interface GetEventsByOrganizationQuery {
|
|
|
25240
26830
|
}
|
|
25241
26831
|
/** Query parameters for `sb.events.tickets.list()`. */
|
|
25242
26832
|
interface GetEventTicketsQuery {
|
|
25243
|
-
/**
|
|
25244
|
-
|
|
25245
|
-
/**
|
|
26833
|
+
/** UUID of the customer whose event tickets to list. */
|
|
26834
|
+
customerRef?: string;
|
|
26835
|
+
/** UUID of the event whose tickets to list. */
|
|
26836
|
+
eventRef?: string;
|
|
26837
|
+
/** @deprecated Use status "canceled" instead. Set to "true" to include deleted event tickets. */
|
|
26838
|
+
includeDeleted?: string;
|
|
26839
|
+
/** Maximum number of event tickets per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
25246
26840
|
limit?: number;
|
|
25247
|
-
/**
|
|
26841
|
+
/** UUID of the location whose event tickets to list. */
|
|
26842
|
+
locationRef?: string;
|
|
26843
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
25248
26844
|
nextPageToken?: string;
|
|
26845
|
+
/** Filter by event ticket status. Comma-separated values, e.g. `active,canceled`. Defaults to `active` when omitted.
|
|
26846
|
+
|
|
26847
|
+
Supported values:
|
|
26848
|
+
- **active** — the ticket is valid
|
|
26849
|
+
- **canceled** — the ticket was deleted */
|
|
26850
|
+
status?: string;
|
|
26851
|
+
/** UUID of the user whose event tickets to list. */
|
|
26852
|
+
userRef?: string;
|
|
25249
26853
|
}
|
|
25250
26854
|
/** Request body for `sb.events.addEventHosts()`. */
|
|
25251
26855
|
type AddEventHostsBody = NonNullable<NonNullable<operations["addEventHosts"]["requestBody"]>["content"]["application/json"]["tickets"]>;
|
|
@@ -25798,12 +27402,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
25798
27402
|
cancel(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
25799
27403
|
copy(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
25800
27404
|
tickets: {
|
|
25801
|
-
list(query
|
|
27405
|
+
list(query?: GetEventTicketsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
25802
27406
|
tickets?: EventTicket[];
|
|
25803
27407
|
nextPageToken?: string;
|
|
25804
27408
|
searchQueryNext?: string;
|
|
25805
27409
|
}>;
|
|
25806
|
-
iterate(query
|
|
27410
|
+
iterate(query?: Omit<GetEventTicketsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<EventTicket, void, undefined>;
|
|
25807
27411
|
get(id: string, options?: SpacebringRequestOptions): Promise<EventTicket>;
|
|
25808
27412
|
update(id: string, ticket: UpdateEventTicketBody, options?: SpacebringRequestOptions): Promise<EventTicket>;
|
|
25809
27413
|
delete(id: string, options?: SpacebringRequestOptions): Promise<EventTicket>;
|
|
@@ -25994,15 +27598,26 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
25994
27598
|
};
|
|
25995
27599
|
credits: {
|
|
25996
27600
|
list(query?: GetCreditsTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
25997
|
-
transactions?: CreditTransaction[];
|
|
25998
27601
|
nextPageToken?: string;
|
|
27602
|
+
searchQueryNext?: string;
|
|
27603
|
+
transactions: CreditTransaction[];
|
|
25999
27604
|
}>;
|
|
26000
27605
|
iterate(query?: Omit<GetCreditsTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditTransaction, void, undefined>;
|
|
27606
|
+
get(id: string, options?: SpacebringRequestOptions): Promise<CreditTransaction>;
|
|
26001
27607
|
create(transaction: CreateCreditsTransactionBody, options?: SpacebringRequestOptions): Promise<CreditTransaction>;
|
|
27608
|
+
scheduled: {
|
|
27609
|
+
list(query?: GetScheduledCreditsTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
27610
|
+
nextPageToken?: string;
|
|
27611
|
+
scheduledTransactions: CreditScheduledTransaction[];
|
|
27612
|
+
searchQueryNext?: string;
|
|
27613
|
+
}>;
|
|
27614
|
+
iterate(query?: Omit<GetScheduledCreditsTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditScheduledTransaction, void, undefined>;
|
|
27615
|
+
};
|
|
26002
27616
|
};
|
|
26003
27617
|
dayPasses: {
|
|
26004
27618
|
list(query?: GetDayPassesTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
26005
27619
|
nextPageToken?: string;
|
|
27620
|
+
searchQueryNext?: string;
|
|
26006
27621
|
transactions: DayPassTransaction[];
|
|
26007
27622
|
}>;
|
|
26008
27623
|
iterate(query?: Omit<GetDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<DayPassTransaction, void, undefined>;
|
|
@@ -26011,10 +27626,10 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
26011
27626
|
scheduled: {
|
|
26012
27627
|
list(query?: GetScheduledDayPassesTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
26013
27628
|
nextPageToken?: string;
|
|
26014
|
-
scheduledTransactions:
|
|
27629
|
+
scheduledTransactions: DayPassScheduledTransaction[];
|
|
26015
27630
|
searchQueryNext?: string;
|
|
26016
27631
|
}>;
|
|
26017
|
-
iterate(query?: Omit<GetScheduledDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<
|
|
27632
|
+
iterate(query?: Omit<GetScheduledDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<DayPassScheduledTransaction, void, undefined>;
|
|
26018
27633
|
};
|
|
26019
27634
|
};
|
|
26020
27635
|
money: {
|
|
@@ -26124,4 +27739,4 @@ declare class SpacebringError extends Error {
|
|
|
26124
27739
|
});
|
|
26125
27740
|
}
|
|
26126
27741
|
|
|
26127
|
-
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditTransaction, 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 GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type
|
|
27742
|
+
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, type Assignment, type Balance, type Benefit, type BenefitCategory, type Booking, type CheckInVisitBody, type CheckOutVisitBody, type Comment, type Company, type Contact, type Contract, type Coupon, type CreateAltCurrencyBody, type CreateBenefitBody, type CreateBenefitCategoryBody, type CreateBookingBody, type CreateCompanyBody, type CreateContactBody, type CreateContractBody, type CreateCouponBody, type CreateCreditNoteBody, type CreateCreditsTransactionBody, type CreateDayPassesTransactionBody, type CreateEventBody, type CreateFeedPostBody, type CreateFeedPostCommentBody, type CreateGuideBody, type CreateInvoiceBody, type CreateInvoiceItemBody, type CreateMembershipBody, type CreatePackageBody, type CreatePlanBody, type CreateProductBody, type CreatePromocodeBody, type CreateRequestBody, type CreateResourceBody, type CreateShopCategoryBody, type CreateSubscriptionBody, type CreateSubscriptionItemBody, type CreateSupportTicketBody, type CreateSupportTicketCommentBody, type CreateTemplateBody, type CreateVisitBody, type CreditNote, type CreditScheduledTransaction, type CreditTransaction, type DayPassScheduledTransaction, type DayPassTransaction, type Event, type EventTicket, type GetAltCurrenciesQuery, type GetAssignmentsQuery, type GetBenefitApplicationsQuery, type GetBenefitCategoriesQuery, type GetBenefitsQuery, type GetBookingsQuery, type GetCompaniesQuery, type GetContactsQuery, type GetContractsQuery, type GetCouponsQuery, type GetCreditNotesQuery, type GetCreditsTransactionsQuery, type GetDayPassesTransactionsQuery, type GetDiscountRedemptionsQuery, type GetEventTicketsQuery, type GetEventsByOrganizationQuery, type GetFeedPostsQuery, type GetFloorsQuery, type GetGuidesQuery, type GetInvoicesQuery, type GetMembershipsDeletedQuery, type GetMembershipsQuery, type GetMoneyTransactionsQuery, type GetOrdersQuery, type GetPackagesQuery, type GetPlansQuery, type GetProductsQuery, type GetPromocodesQuery, type GetRegistrationsQuery, type GetRequestsQuery, type GetResourcesQuery, type GetScheduledCreditsTransactionsQuery, type GetScheduledDayPassesTransactionsQuery, type GetShopCategoriesQuery, type GetSubscriptionsQuery, type GetSupportTicketsQuery, type GetTemplatesQuery, type GetUpcomingInvoiceItemsQuery, type GetUpcomingInvoiceQuery, type GetVisitsQuery, type Guide, type Invoice, type InvoiceItem, type IssueContractBody, type IssueInvoiceBody, type Like, type ListInvoiceItemsQuery, type Location, type Membership, type MoneyTransaction, type Network, type Order, type Package, type PatchGuideBody, type PatchPackageBody, type PatchResourceBody, type PayInvoiceBody, type Payment, type Plan, type Post, type PreviewCreditNoteBody, type Product, type Promocode, type Redemption, type Registration, type Request$1 as Request, type Resource, type ShopCategory, Spacebring, type SpacebringConfig, SpacebringError, type SpacebringErrorBody, type SpacebringRequestOptions, type SpacebringResources, type Subscription, type SupportTicket, type Template, type TerminateContractBody, type UpcomingItem, type UpdateAltCurrencyBody, type UpdateBenefitBody, type UpdateBenefitCategoryBody, type UpdateCompanyBody, type UpdateContractBody, type UpdateCouponBody, type UpdateCreditNoteBody, type UpdateEventBody, type UpdateEventTicketBody, type UpdateFeedPostBody, type UpdateInvoiceBody, type UpdateInvoiceItemBody, type UpdateMembershipBody, type UpdatePlanBody, type UpdateProductBody, type UpdateShopCategoryBody, type UpdateSubscriptionBody, type UpdateSubscriptionItemBody, type UpdateSupportTicketAssigneeBody, type UpdateSupportTicketStatusBody, type UpdateSupportTicketTypeBody, type UpdateTemplateBody, type UpdateVisitBody, type Visit, type components, type operations, type paths };
|