@izak0s/spacebring-api 3.5.0 → 4.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 +11 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1378 -140
- package/dist/index.d.ts +1378 -140
- package/dist/index.js +11 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2459,6 +2459,26 @@ interface paths {
|
|
|
2459
2459
|
patch?: never;
|
|
2460
2460
|
trace?: never;
|
|
2461
2461
|
};
|
|
2462
|
+
"/transactions/credits/v1/{id}": {
|
|
2463
|
+
parameters: {
|
|
2464
|
+
query?: never;
|
|
2465
|
+
header?: never;
|
|
2466
|
+
path?: never;
|
|
2467
|
+
cookie?: never;
|
|
2468
|
+
};
|
|
2469
|
+
/**
|
|
2470
|
+
* Retrieve a credit transaction
|
|
2471
|
+
* @description Retrieve a credits transaction. <h3>OAuth</h3>Required scopes: <code>transactions.readonly</code> or <code>transactions</code>
|
|
2472
|
+
*/
|
|
2473
|
+
get: operations["getCreditsTransaction"];
|
|
2474
|
+
put?: never;
|
|
2475
|
+
post?: never;
|
|
2476
|
+
delete?: never;
|
|
2477
|
+
options?: never;
|
|
2478
|
+
head?: never;
|
|
2479
|
+
patch?: never;
|
|
2480
|
+
trace?: never;
|
|
2481
|
+
};
|
|
2462
2482
|
"/transactions/day_passes/scheduled/v1": {
|
|
2463
2483
|
parameters: {
|
|
2464
2484
|
query?: never;
|
|
@@ -7506,6 +7526,19 @@ interface components {
|
|
|
7506
7526
|
getGuides: {
|
|
7507
7527
|
/** @description List of guides. */
|
|
7508
7528
|
guides: {
|
|
7529
|
+
/** @description Files attached to the guide. */
|
|
7530
|
+
attachments: {
|
|
7531
|
+
/** @description Storage key of the file. */
|
|
7532
|
+
key: string;
|
|
7533
|
+
/** @description MIME type of the file. */
|
|
7534
|
+
mime: string;
|
|
7535
|
+
/** @description Display name of the file. */
|
|
7536
|
+
name: string;
|
|
7537
|
+
/** @description File size in bytes. */
|
|
7538
|
+
size?: number;
|
|
7539
|
+
/** @description Public URL of the file. */
|
|
7540
|
+
url: string;
|
|
7541
|
+
}[];
|
|
7509
7542
|
/**
|
|
7510
7543
|
* Format: date-time
|
|
7511
7544
|
* @description ISO timestamp of when the guide was created.
|
|
@@ -7552,6 +7585,19 @@ interface components {
|
|
|
7552
7585
|
searchQueryNext?: string;
|
|
7553
7586
|
};
|
|
7554
7587
|
guide: {
|
|
7588
|
+
/** @description Files attached to the guide. */
|
|
7589
|
+
attachments: {
|
|
7590
|
+
/** @description Storage key of the file. */
|
|
7591
|
+
key: string;
|
|
7592
|
+
/** @description MIME type of the file. */
|
|
7593
|
+
mime: string;
|
|
7594
|
+
/** @description Display name of the file. */
|
|
7595
|
+
name: string;
|
|
7596
|
+
/** @description File size in bytes. */
|
|
7597
|
+
size?: number;
|
|
7598
|
+
/** @description Public URL of the file. */
|
|
7599
|
+
url: string;
|
|
7600
|
+
}[];
|
|
7555
7601
|
/**
|
|
7556
7602
|
* Format: date-time
|
|
7557
7603
|
* @description ISO timestamp of when the guide was created.
|
|
@@ -7595,6 +7641,19 @@ interface components {
|
|
|
7595
7641
|
getGuide: {
|
|
7596
7642
|
/** @description The guide. */
|
|
7597
7643
|
guide: {
|
|
7644
|
+
/** @description Files attached to the guide. */
|
|
7645
|
+
attachments: {
|
|
7646
|
+
/** @description Storage key of the file. */
|
|
7647
|
+
key: string;
|
|
7648
|
+
/** @description MIME type of the file. */
|
|
7649
|
+
mime: string;
|
|
7650
|
+
/** @description Display name of the file. */
|
|
7651
|
+
name: string;
|
|
7652
|
+
/** @description File size in bytes. */
|
|
7653
|
+
size?: number;
|
|
7654
|
+
/** @description Public URL of the file. */
|
|
7655
|
+
url: string;
|
|
7656
|
+
}[];
|
|
7598
7657
|
/**
|
|
7599
7658
|
* Format: date-time
|
|
7600
7659
|
* @description ISO timestamp of when the guide was created.
|
|
@@ -12388,101 +12447,1189 @@ interface components {
|
|
|
12388
12447
|
*/
|
|
12389
12448
|
type: "assigneeUpdated" | "comment" | "statusUpdated" | "ticketCreated";
|
|
12390
12449
|
};
|
|
12391
|
-
|
|
12392
|
-
|
|
12393
|
-
|
|
12394
|
-
|
|
12395
|
-
|
|
12396
|
-
|
|
12397
|
-
|
|
12398
|
-
|
|
12399
|
-
|
|
12450
|
+
getCreditsTransactions: {
|
|
12451
|
+
/** @description Pagination token to fetch the next page of results. */
|
|
12452
|
+
nextPageToken?: string;
|
|
12453
|
+
/** @description Ready-to-use query string with the current filters and nextPageToken to fetch the next page of results. */
|
|
12454
|
+
searchQueryNext?: string;
|
|
12455
|
+
/** @description List of credits transactions. */
|
|
12456
|
+
transactions: {
|
|
12457
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
12458
|
+
amount: number;
|
|
12459
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
12460
|
+
amounts: {
|
|
12461
|
+
/** @description Amount deducted from this balance bucket. */
|
|
12462
|
+
amount: number;
|
|
12463
|
+
/**
|
|
12464
|
+
* Format: date-time
|
|
12465
|
+
* @description Expiration date for expiring balances.
|
|
12466
|
+
*/
|
|
12467
|
+
expirationDate?: string;
|
|
12468
|
+
/**
|
|
12469
|
+
* Format: uuid
|
|
12470
|
+
* @description Subscription associated with expiring balances.
|
|
12471
|
+
*/
|
|
12472
|
+
subscriptionRef?: string;
|
|
12473
|
+
/**
|
|
12474
|
+
* @description Balance bucket type.
|
|
12475
|
+
* @enum {string}
|
|
12476
|
+
*/
|
|
12477
|
+
type: "expiring" | "permanent";
|
|
12478
|
+
}[];
|
|
12479
|
+
/**
|
|
12480
|
+
* @deprecated
|
|
12481
|
+
* @description Deprecated. Use product instead.
|
|
12482
|
+
*/
|
|
12483
|
+
booking?: {
|
|
12484
|
+
/**
|
|
12485
|
+
* Format: date-time
|
|
12486
|
+
* @description Booking end date.
|
|
12487
|
+
*/
|
|
12488
|
+
endDate?: string;
|
|
12489
|
+
/**
|
|
12490
|
+
* Format: uuid
|
|
12491
|
+
* @description Booking id.
|
|
12492
|
+
*/
|
|
12493
|
+
id: string;
|
|
12494
|
+
/** @description Booked resource. */
|
|
12495
|
+
resource: {
|
|
12496
|
+
/**
|
|
12497
|
+
* Format: uuid
|
|
12498
|
+
* @description Resource id.
|
|
12499
|
+
*/
|
|
12500
|
+
id: string;
|
|
12501
|
+
/** @description Resource title. */
|
|
12502
|
+
title: string;
|
|
12503
|
+
};
|
|
12504
|
+
/**
|
|
12505
|
+
* Format: date-time
|
|
12506
|
+
* @description Booking start date.
|
|
12507
|
+
*/
|
|
12508
|
+
startDate?: string;
|
|
12400
12509
|
};
|
|
12401
|
-
|
|
12402
|
-
|
|
12403
|
-
|
|
12404
|
-
|
|
12405
|
-
|
|
12406
|
-
|
|
12407
|
-
|
|
12408
|
-
|
|
12409
|
-
|
|
12410
|
-
|
|
12411
|
-
|
|
12412
|
-
|
|
12413
|
-
|
|
12414
|
-
|
|
12415
|
-
|
|
12416
|
-
|
|
12417
|
-
|
|
12418
|
-
|
|
12419
|
-
|
|
12420
|
-
|
|
12421
|
-
/**
|
|
12422
|
-
|
|
12423
|
-
|
|
12510
|
+
/**
|
|
12511
|
+
* @deprecated
|
|
12512
|
+
* @description Deprecated. Use customer instead.
|
|
12513
|
+
*/
|
|
12514
|
+
company?: {
|
|
12515
|
+
/**
|
|
12516
|
+
* Format: date-time
|
|
12517
|
+
* @description ISO timestamp of company creation.
|
|
12518
|
+
*/
|
|
12519
|
+
createDate: string;
|
|
12520
|
+
/**
|
|
12521
|
+
* Format: uuid
|
|
12522
|
+
* @description Company id.
|
|
12523
|
+
*/
|
|
12524
|
+
id: string;
|
|
12525
|
+
/**
|
|
12526
|
+
* Format: uuid
|
|
12527
|
+
* @description Location id.
|
|
12528
|
+
*/
|
|
12529
|
+
locationRef: string;
|
|
12530
|
+
/** @description Company logo. */
|
|
12531
|
+
logo?: {
|
|
12532
|
+
/** @description Storage key of the company logo. */
|
|
12533
|
+
key: string;
|
|
12534
|
+
/** @description Public URL of the company logo. */
|
|
12535
|
+
url: string;
|
|
12536
|
+
};
|
|
12537
|
+
/** @description Company metadata. */
|
|
12538
|
+
metadata?: {
|
|
12539
|
+
[key: string]: unknown;
|
|
12540
|
+
};
|
|
12541
|
+
/** @description Internal notes. */
|
|
12542
|
+
notes?: string;
|
|
12543
|
+
/** @description Public logo URL derived from the company website. */
|
|
12544
|
+
publicLogoUrl?: string;
|
|
12545
|
+
/**
|
|
12546
|
+
* Format: uuid
|
|
12547
|
+
* @description Primary subscription id.
|
|
12548
|
+
*/
|
|
12549
|
+
subscriptionRef: string | null;
|
|
12550
|
+
/** @description Company name. */
|
|
12551
|
+
title: string;
|
|
12424
12552
|
};
|
|
12425
|
-
|
|
12426
|
-
|
|
12427
|
-
|
|
12553
|
+
/**
|
|
12554
|
+
* Format: uuid
|
|
12555
|
+
* @deprecated
|
|
12556
|
+
* @description Deprecated. Use customer instead.
|
|
12557
|
+
*/
|
|
12558
|
+
companyRef?: string;
|
|
12559
|
+
/**
|
|
12560
|
+
* Format: date-time
|
|
12561
|
+
* @description ISO timestamp of when the transaction was created.
|
|
12562
|
+
*/
|
|
12563
|
+
createDate: string;
|
|
12564
|
+
/** @description Customer associated with this transaction. */
|
|
12565
|
+
customer: {
|
|
12566
|
+
/**
|
|
12567
|
+
* Format: uuid
|
|
12568
|
+
* @description ID of the company or membership.
|
|
12569
|
+
*/
|
|
12570
|
+
id: string;
|
|
12571
|
+
/** @description Company logo. */
|
|
12572
|
+
logo?: {
|
|
12573
|
+
key: string;
|
|
12574
|
+
url: string;
|
|
12575
|
+
};
|
|
12576
|
+
/** @description Company name. */
|
|
12428
12577
|
title?: string;
|
|
12578
|
+
/**
|
|
12579
|
+
* @description Whether the customer is a company or a user.
|
|
12580
|
+
* @enum {string}
|
|
12581
|
+
*/
|
|
12582
|
+
type: "company" | "user";
|
|
12583
|
+
/** @description User details for membership customers. */
|
|
12584
|
+
user?: {
|
|
12585
|
+
about?: string | null;
|
|
12586
|
+
email?: string | null;
|
|
12587
|
+
/** Format: uuid */
|
|
12588
|
+
id: string;
|
|
12589
|
+
name?: string | null;
|
|
12590
|
+
phoneNumber?: string | null;
|
|
12591
|
+
photoUrl?: string | null;
|
|
12592
|
+
surname?: string | null;
|
|
12593
|
+
};
|
|
12429
12594
|
};
|
|
12430
|
-
|
|
12431
|
-
|
|
12432
|
-
|
|
12433
|
-
|
|
12434
|
-
|
|
12435
|
-
|
|
12436
|
-
|
|
12437
|
-
|
|
12595
|
+
/** @description Transaction description. */
|
|
12596
|
+
description?: string;
|
|
12597
|
+
/** @description Discounts applied to the transaction. */
|
|
12598
|
+
discounts?: {
|
|
12599
|
+
/** @description Applied coupon. */
|
|
12600
|
+
coupon: {
|
|
12601
|
+
/** @description Fixed amount discount. */
|
|
12602
|
+
amountOff?: number;
|
|
12603
|
+
/** @description Currency of the fixed amount discount. */
|
|
12604
|
+
currencyCode?: string;
|
|
12605
|
+
/** @description Coupon id. */
|
|
12606
|
+
id: string;
|
|
12607
|
+
/** @description Percentage discount. */
|
|
12608
|
+
percentOff?: number;
|
|
12609
|
+
/** @description Product types the coupon applies to. */
|
|
12610
|
+
productTypes?: string[];
|
|
12611
|
+
/** @description Coupon type. */
|
|
12612
|
+
type: string;
|
|
12613
|
+
};
|
|
12614
|
+
/** @description Promocode the coupon was applied with. */
|
|
12615
|
+
promocode?: {
|
|
12616
|
+
/** @description Promocode. */
|
|
12617
|
+
code: string;
|
|
12618
|
+
/** @description Promocode expiration date. */
|
|
12619
|
+
expiration?: string;
|
|
12620
|
+
/**
|
|
12621
|
+
* Format: uuid
|
|
12622
|
+
* @description Promocode id.
|
|
12623
|
+
*/
|
|
12624
|
+
id: string;
|
|
12625
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
12626
|
+
limitByFirstPurchase?: boolean;
|
|
12627
|
+
};
|
|
12628
|
+
/**
|
|
12629
|
+
* Format: uuid
|
|
12630
|
+
* @description ID of the subscription this discount is associated with.
|
|
12631
|
+
*/
|
|
12632
|
+
subscriptionId?: string;
|
|
12633
|
+
}[];
|
|
12634
|
+
/**
|
|
12635
|
+
* @deprecated
|
|
12636
|
+
* @description Deprecated. Use amounts instead.
|
|
12637
|
+
*/
|
|
12638
|
+
expiringAmount?: number;
|
|
12639
|
+
/**
|
|
12640
|
+
* Format: uuid
|
|
12641
|
+
* @description Unique identifier of the transaction.
|
|
12642
|
+
*/
|
|
12643
|
+
id: string;
|
|
12644
|
+
/**
|
|
12645
|
+
* Format: uuid
|
|
12646
|
+
* @description ID of the organization (location).
|
|
12647
|
+
*/
|
|
12648
|
+
locationRef: string;
|
|
12649
|
+
/**
|
|
12650
|
+
* Format: uuid
|
|
12651
|
+
* @deprecated
|
|
12652
|
+
* @description Deprecated. Use customer instead.
|
|
12653
|
+
*/
|
|
12654
|
+
membershipRef?: string;
|
|
12655
|
+
/**
|
|
12656
|
+
* Format: uuid
|
|
12657
|
+
* @deprecated
|
|
12658
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12659
|
+
*/
|
|
12660
|
+
membershipRefCreator?: string;
|
|
12661
|
+
/**
|
|
12662
|
+
* Format: uuid
|
|
12663
|
+
* @description ID of the network.
|
|
12664
|
+
*/
|
|
12665
|
+
networkRef: string;
|
|
12666
|
+
/**
|
|
12667
|
+
* @deprecated
|
|
12668
|
+
* @description Deprecated. Use product instead.
|
|
12669
|
+
*/
|
|
12670
|
+
order?: {
|
|
12671
|
+
/**
|
|
12672
|
+
* Format: uuid
|
|
12673
|
+
* @description Order id.
|
|
12674
|
+
*/
|
|
12675
|
+
id: string;
|
|
12676
|
+
/** @description Order items. */
|
|
12677
|
+
items: {
|
|
12678
|
+
/**
|
|
12679
|
+
* Format: uuid
|
|
12680
|
+
* @description Order item id.
|
|
12681
|
+
*/
|
|
12682
|
+
id: string;
|
|
12683
|
+
/** @description Ordered product. */
|
|
12684
|
+
product: {
|
|
12685
|
+
/**
|
|
12686
|
+
* Format: uuid
|
|
12687
|
+
* @description Product id.
|
|
12688
|
+
*/
|
|
12689
|
+
id: string;
|
|
12690
|
+
/** @description Product option. */
|
|
12691
|
+
option?: {
|
|
12692
|
+
/**
|
|
12693
|
+
* Format: uuid
|
|
12694
|
+
* @description Product option id.
|
|
12695
|
+
*/
|
|
12696
|
+
id: string;
|
|
12697
|
+
/** @description Product option title. */
|
|
12698
|
+
title: string;
|
|
12699
|
+
};
|
|
12700
|
+
/** @description Product title. */
|
|
12701
|
+
title: string;
|
|
12702
|
+
};
|
|
12703
|
+
/** @description Quantity of units. */
|
|
12704
|
+
quantity: number;
|
|
12705
|
+
}[];
|
|
12706
|
+
};
|
|
12707
|
+
/**
|
|
12708
|
+
* @deprecated
|
|
12709
|
+
* @description Deprecated. Use amounts instead.
|
|
12710
|
+
*/
|
|
12711
|
+
permanentAmount?: number;
|
|
12712
|
+
/** @description Product details. */
|
|
12713
|
+
product?: {
|
|
12714
|
+
/**
|
|
12715
|
+
* Format: uuid
|
|
12716
|
+
* @description ID of the associated booking.
|
|
12717
|
+
*/
|
|
12718
|
+
bookingRef?: string;
|
|
12719
|
+
/**
|
|
12720
|
+
* Format: uuid
|
|
12721
|
+
* @description ID of the associated event ticket.
|
|
12722
|
+
*/
|
|
12723
|
+
eventTicketRef?: string;
|
|
12724
|
+
/**
|
|
12725
|
+
* Format: uuid
|
|
12726
|
+
* @description ID of the associated order.
|
|
12727
|
+
*/
|
|
12728
|
+
orderRef?: string;
|
|
12729
|
+
/** @description Display title of the product. */
|
|
12730
|
+
title?: string;
|
|
12731
|
+
/**
|
|
12732
|
+
* @description Product type.
|
|
12733
|
+
* @enum {string}
|
|
12734
|
+
*/
|
|
12735
|
+
type?: "booking" | "eventTicket" | "order";
|
|
12736
|
+
};
|
|
12737
|
+
/**
|
|
12738
|
+
* @deprecated
|
|
12739
|
+
* @description Deprecated.
|
|
12740
|
+
*/
|
|
12741
|
+
refund?: {
|
|
12742
|
+
/** @description Refunded amount. */
|
|
12743
|
+
amount: number;
|
|
12744
|
+
/**
|
|
12745
|
+
* Format: date-time
|
|
12746
|
+
* @description Refund creation timestamp.
|
|
12747
|
+
*/
|
|
12748
|
+
createDate: string;
|
|
12749
|
+
};
|
|
12750
|
+
/** @description Transaction status. */
|
|
12751
|
+
status: string;
|
|
12752
|
+
/**
|
|
12753
|
+
* @deprecated
|
|
12754
|
+
* @description Deprecated. Use product instead.
|
|
12755
|
+
*/
|
|
12756
|
+
ticket?: {
|
|
12757
|
+
/**
|
|
12758
|
+
* Format: date-time
|
|
12759
|
+
* @description Ticket creation timestamp.
|
|
12760
|
+
*/
|
|
12761
|
+
createDate?: string;
|
|
12762
|
+
/** @description Event details. */
|
|
12763
|
+
event?: {
|
|
12764
|
+
/**
|
|
12765
|
+
* Format: date-time
|
|
12766
|
+
* @description Event end date.
|
|
12767
|
+
*/
|
|
12768
|
+
endDate?: string;
|
|
12769
|
+
/**
|
|
12770
|
+
* Format: uuid
|
|
12771
|
+
* @description Event id.
|
|
12772
|
+
*/
|
|
12773
|
+
id: string;
|
|
12774
|
+
/**
|
|
12775
|
+
* Format: date-time
|
|
12776
|
+
* @description Event start date.
|
|
12777
|
+
*/
|
|
12778
|
+
startDate?: string;
|
|
12779
|
+
/** @description Event title. */
|
|
12780
|
+
title: string;
|
|
12781
|
+
};
|
|
12782
|
+
/**
|
|
12783
|
+
* Format: uuid
|
|
12784
|
+
* @description Ticket id.
|
|
12785
|
+
*/
|
|
12786
|
+
id: string;
|
|
12787
|
+
/** @description Number of tickets. */
|
|
12788
|
+
quantity: number;
|
|
12789
|
+
};
|
|
12790
|
+
/**
|
|
12791
|
+
* @description Credits transaction type.
|
|
12792
|
+
* @enum {string}
|
|
12793
|
+
*/
|
|
12794
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "eventTicket" | "expiration" | "order" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
12795
|
+
/** @description User who created the transaction. */
|
|
12796
|
+
userCreatedBy?: {
|
|
12797
|
+
about?: string | null;
|
|
12798
|
+
email?: string | null;
|
|
12799
|
+
/** Format: uuid */
|
|
12800
|
+
id: string;
|
|
12801
|
+
name?: string | null;
|
|
12802
|
+
phoneNumber?: string | null;
|
|
12803
|
+
photoUrl?: string | null;
|
|
12804
|
+
surname?: string | null;
|
|
12805
|
+
};
|
|
12806
|
+
/**
|
|
12807
|
+
* @deprecated
|
|
12808
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12809
|
+
*/
|
|
12810
|
+
userCreator?: {
|
|
12811
|
+
about?: string | null;
|
|
12812
|
+
email?: string | null;
|
|
12813
|
+
/** Format: uuid */
|
|
12814
|
+
id: string;
|
|
12815
|
+
name?: string | null;
|
|
12816
|
+
phoneNumber?: string | null;
|
|
12817
|
+
photoUrl?: string | null;
|
|
12818
|
+
surname?: string | null;
|
|
12819
|
+
};
|
|
12820
|
+
/**
|
|
12821
|
+
* @deprecated
|
|
12822
|
+
* @description Deprecated. Use customer.user instead.
|
|
12823
|
+
*/
|
|
12824
|
+
userOwner?: {
|
|
12825
|
+
about?: string | null;
|
|
12826
|
+
email?: string | null;
|
|
12827
|
+
/** Format: uuid */
|
|
12828
|
+
id: string;
|
|
12829
|
+
name?: string | null;
|
|
12830
|
+
phoneNumber?: string | null;
|
|
12831
|
+
photoUrl?: string | null;
|
|
12832
|
+
surname?: string | null;
|
|
12833
|
+
};
|
|
12834
|
+
/**
|
|
12835
|
+
* Format: uuid
|
|
12836
|
+
* @deprecated
|
|
12837
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12838
|
+
*/
|
|
12839
|
+
userRefCreator?: string;
|
|
12840
|
+
/**
|
|
12841
|
+
* Format: uuid
|
|
12842
|
+
* @deprecated
|
|
12843
|
+
* @description Deprecated. Use customer.user instead.
|
|
12844
|
+
*/
|
|
12845
|
+
userRefOwner?: string;
|
|
12846
|
+
}[];
|
|
12847
|
+
};
|
|
12848
|
+
createCreditsTransaction: {
|
|
12849
|
+
/** @description The created credits transaction. */
|
|
12850
|
+
transaction: {
|
|
12851
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
12852
|
+
amount: number;
|
|
12853
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
12854
|
+
amounts: {
|
|
12855
|
+
/** @description Amount deducted from this balance bucket. */
|
|
12856
|
+
amount: number;
|
|
12857
|
+
/**
|
|
12858
|
+
* Format: date-time
|
|
12859
|
+
* @description Expiration date for expiring balances.
|
|
12860
|
+
*/
|
|
12861
|
+
expirationDate?: string;
|
|
12862
|
+
/**
|
|
12863
|
+
* Format: uuid
|
|
12864
|
+
* @description Subscription associated with expiring balances.
|
|
12865
|
+
*/
|
|
12866
|
+
subscriptionRef?: string;
|
|
12867
|
+
/**
|
|
12868
|
+
* @description Balance bucket type.
|
|
12869
|
+
* @enum {string}
|
|
12870
|
+
*/
|
|
12871
|
+
type: "expiring" | "permanent";
|
|
12872
|
+
}[];
|
|
12873
|
+
/**
|
|
12874
|
+
* @deprecated
|
|
12875
|
+
* @description Deprecated. Use product instead.
|
|
12876
|
+
*/
|
|
12877
|
+
booking?: {
|
|
12878
|
+
/**
|
|
12879
|
+
* Format: date-time
|
|
12880
|
+
* @description Booking end date.
|
|
12881
|
+
*/
|
|
12882
|
+
endDate?: string;
|
|
12883
|
+
/**
|
|
12884
|
+
* Format: uuid
|
|
12885
|
+
* @description Booking id.
|
|
12886
|
+
*/
|
|
12887
|
+
id: string;
|
|
12888
|
+
/** @description Booked resource. */
|
|
12889
|
+
resource: {
|
|
12890
|
+
/**
|
|
12891
|
+
* Format: uuid
|
|
12892
|
+
* @description Resource id.
|
|
12893
|
+
*/
|
|
12894
|
+
id: string;
|
|
12895
|
+
/** @description Resource title. */
|
|
12896
|
+
title: string;
|
|
12897
|
+
};
|
|
12898
|
+
/**
|
|
12899
|
+
* Format: date-time
|
|
12900
|
+
* @description Booking start date.
|
|
12901
|
+
*/
|
|
12902
|
+
startDate?: string;
|
|
12903
|
+
};
|
|
12904
|
+
/**
|
|
12905
|
+
* @deprecated
|
|
12906
|
+
* @description Deprecated. Use customer instead.
|
|
12907
|
+
*/
|
|
12908
|
+
company?: {
|
|
12909
|
+
/**
|
|
12910
|
+
* Format: date-time
|
|
12911
|
+
* @description ISO timestamp of company creation.
|
|
12912
|
+
*/
|
|
12913
|
+
createDate: string;
|
|
12914
|
+
/**
|
|
12915
|
+
* Format: uuid
|
|
12916
|
+
* @description Company id.
|
|
12917
|
+
*/
|
|
12918
|
+
id: string;
|
|
12919
|
+
/**
|
|
12920
|
+
* Format: uuid
|
|
12921
|
+
* @description Location id.
|
|
12922
|
+
*/
|
|
12923
|
+
locationRef: string;
|
|
12924
|
+
/** @description Company logo. */
|
|
12925
|
+
logo?: {
|
|
12926
|
+
/** @description Storage key of the company logo. */
|
|
12927
|
+
key: string;
|
|
12928
|
+
/** @description Public URL of the company logo. */
|
|
12929
|
+
url: string;
|
|
12930
|
+
};
|
|
12931
|
+
/** @description Company metadata. */
|
|
12932
|
+
metadata?: {
|
|
12933
|
+
[key: string]: unknown;
|
|
12934
|
+
};
|
|
12935
|
+
/** @description Internal notes. */
|
|
12936
|
+
notes?: string;
|
|
12937
|
+
/** @description Public logo URL derived from the company website. */
|
|
12938
|
+
publicLogoUrl?: string;
|
|
12939
|
+
/**
|
|
12940
|
+
* Format: uuid
|
|
12941
|
+
* @description Primary subscription id.
|
|
12942
|
+
*/
|
|
12943
|
+
subscriptionRef: string | null;
|
|
12944
|
+
/** @description Company name. */
|
|
12945
|
+
title: string;
|
|
12946
|
+
};
|
|
12947
|
+
/**
|
|
12948
|
+
* Format: uuid
|
|
12949
|
+
* @deprecated
|
|
12950
|
+
* @description Deprecated. Use customer instead.
|
|
12951
|
+
*/
|
|
12952
|
+
companyRef?: string;
|
|
12953
|
+
/**
|
|
12954
|
+
* Format: date-time
|
|
12955
|
+
* @description ISO timestamp of when the transaction was created.
|
|
12956
|
+
*/
|
|
12957
|
+
createDate: string;
|
|
12958
|
+
/** @description Customer associated with this transaction. */
|
|
12959
|
+
customer: {
|
|
12960
|
+
/**
|
|
12961
|
+
* Format: uuid
|
|
12962
|
+
* @description ID of the company or membership.
|
|
12963
|
+
*/
|
|
12964
|
+
id: string;
|
|
12965
|
+
/** @description Company logo. */
|
|
12966
|
+
logo?: {
|
|
12967
|
+
key: string;
|
|
12968
|
+
url: string;
|
|
12969
|
+
};
|
|
12970
|
+
/** @description Company name. */
|
|
12971
|
+
title?: string;
|
|
12972
|
+
/**
|
|
12973
|
+
* @description Whether the customer is a company or a user.
|
|
12974
|
+
* @enum {string}
|
|
12975
|
+
*/
|
|
12976
|
+
type: "company" | "user";
|
|
12977
|
+
/** @description User details for membership customers. */
|
|
12978
|
+
user?: {
|
|
12979
|
+
about?: string | null;
|
|
12980
|
+
email?: string | null;
|
|
12981
|
+
/** Format: uuid */
|
|
12982
|
+
id: string;
|
|
12983
|
+
name?: string | null;
|
|
12984
|
+
phoneNumber?: string | null;
|
|
12985
|
+
photoUrl?: string | null;
|
|
12986
|
+
surname?: string | null;
|
|
12987
|
+
};
|
|
12988
|
+
};
|
|
12989
|
+
/** @description Transaction description. */
|
|
12990
|
+
description?: string;
|
|
12991
|
+
/** @description Discounts applied to the transaction. */
|
|
12992
|
+
discounts?: {
|
|
12993
|
+
/** @description Applied coupon. */
|
|
12994
|
+
coupon: {
|
|
12995
|
+
/** @description Fixed amount discount. */
|
|
12996
|
+
amountOff?: number;
|
|
12997
|
+
/** @description Currency of the fixed amount discount. */
|
|
12998
|
+
currencyCode?: string;
|
|
12999
|
+
/** @description Coupon id. */
|
|
13000
|
+
id: string;
|
|
13001
|
+
/** @description Percentage discount. */
|
|
13002
|
+
percentOff?: number;
|
|
13003
|
+
/** @description Product types the coupon applies to. */
|
|
13004
|
+
productTypes?: string[];
|
|
13005
|
+
/** @description Coupon type. */
|
|
13006
|
+
type: string;
|
|
13007
|
+
};
|
|
13008
|
+
/** @description Promocode the coupon was applied with. */
|
|
13009
|
+
promocode?: {
|
|
13010
|
+
/** @description Promocode. */
|
|
13011
|
+
code: string;
|
|
13012
|
+
/** @description Promocode expiration date. */
|
|
13013
|
+
expiration?: string;
|
|
13014
|
+
/**
|
|
13015
|
+
* Format: uuid
|
|
13016
|
+
* @description Promocode id.
|
|
13017
|
+
*/
|
|
13018
|
+
id: string;
|
|
13019
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
13020
|
+
limitByFirstPurchase?: boolean;
|
|
13021
|
+
};
|
|
13022
|
+
/**
|
|
13023
|
+
* Format: uuid
|
|
13024
|
+
* @description ID of the subscription this discount is associated with.
|
|
13025
|
+
*/
|
|
13026
|
+
subscriptionId?: string;
|
|
13027
|
+
}[];
|
|
13028
|
+
/**
|
|
13029
|
+
* @deprecated
|
|
13030
|
+
* @description Deprecated. Use amounts instead.
|
|
13031
|
+
*/
|
|
13032
|
+
expiringAmount?: number;
|
|
13033
|
+
/**
|
|
13034
|
+
* Format: uuid
|
|
13035
|
+
* @description Unique identifier of the transaction.
|
|
13036
|
+
*/
|
|
13037
|
+
id: string;
|
|
13038
|
+
/**
|
|
13039
|
+
* Format: uuid
|
|
13040
|
+
* @description ID of the organization (location).
|
|
13041
|
+
*/
|
|
13042
|
+
locationRef: string;
|
|
13043
|
+
/**
|
|
13044
|
+
* Format: uuid
|
|
13045
|
+
* @deprecated
|
|
13046
|
+
* @description Deprecated. Use customer instead.
|
|
13047
|
+
*/
|
|
13048
|
+
membershipRef?: string;
|
|
13049
|
+
/**
|
|
13050
|
+
* Format: uuid
|
|
13051
|
+
* @deprecated
|
|
13052
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13053
|
+
*/
|
|
13054
|
+
membershipRefCreator?: string;
|
|
13055
|
+
/**
|
|
13056
|
+
* Format: uuid
|
|
13057
|
+
* @description ID of the network.
|
|
13058
|
+
*/
|
|
13059
|
+
networkRef: string;
|
|
13060
|
+
/**
|
|
13061
|
+
* @deprecated
|
|
13062
|
+
* @description Deprecated. Use product instead.
|
|
13063
|
+
*/
|
|
13064
|
+
order?: {
|
|
13065
|
+
/**
|
|
13066
|
+
* Format: uuid
|
|
13067
|
+
* @description Order id.
|
|
13068
|
+
*/
|
|
13069
|
+
id: string;
|
|
13070
|
+
/** @description Order items. */
|
|
13071
|
+
items: {
|
|
13072
|
+
/**
|
|
13073
|
+
* Format: uuid
|
|
13074
|
+
* @description Order item id.
|
|
13075
|
+
*/
|
|
13076
|
+
id: string;
|
|
13077
|
+
/** @description Ordered product. */
|
|
13078
|
+
product: {
|
|
13079
|
+
/**
|
|
13080
|
+
* Format: uuid
|
|
13081
|
+
* @description Product id.
|
|
13082
|
+
*/
|
|
13083
|
+
id: string;
|
|
13084
|
+
/** @description Product option. */
|
|
13085
|
+
option?: {
|
|
13086
|
+
/**
|
|
13087
|
+
* Format: uuid
|
|
13088
|
+
* @description Product option id.
|
|
13089
|
+
*/
|
|
13090
|
+
id: string;
|
|
13091
|
+
/** @description Product option title. */
|
|
13092
|
+
title: string;
|
|
13093
|
+
};
|
|
13094
|
+
/** @description Product title. */
|
|
13095
|
+
title: string;
|
|
13096
|
+
};
|
|
13097
|
+
/** @description Quantity of units. */
|
|
13098
|
+
quantity: number;
|
|
13099
|
+
}[];
|
|
13100
|
+
};
|
|
13101
|
+
/**
|
|
13102
|
+
* @deprecated
|
|
13103
|
+
* @description Deprecated. Use amounts instead.
|
|
13104
|
+
*/
|
|
13105
|
+
permanentAmount?: number;
|
|
13106
|
+
/** @description Product details. */
|
|
13107
|
+
product?: {
|
|
13108
|
+
/**
|
|
13109
|
+
* Format: uuid
|
|
13110
|
+
* @description ID of the associated booking.
|
|
13111
|
+
*/
|
|
13112
|
+
bookingRef?: string;
|
|
13113
|
+
/**
|
|
13114
|
+
* Format: uuid
|
|
13115
|
+
* @description ID of the associated event ticket.
|
|
13116
|
+
*/
|
|
13117
|
+
eventTicketRef?: string;
|
|
13118
|
+
/**
|
|
13119
|
+
* Format: uuid
|
|
13120
|
+
* @description ID of the associated order.
|
|
13121
|
+
*/
|
|
13122
|
+
orderRef?: string;
|
|
13123
|
+
/** @description Display title of the product. */
|
|
13124
|
+
title?: string;
|
|
13125
|
+
/**
|
|
13126
|
+
* @description Product type.
|
|
13127
|
+
* @enum {string}
|
|
13128
|
+
*/
|
|
13129
|
+
type?: "booking" | "eventTicket" | "order";
|
|
13130
|
+
};
|
|
13131
|
+
/**
|
|
13132
|
+
* @deprecated
|
|
13133
|
+
* @description Deprecated.
|
|
13134
|
+
*/
|
|
13135
|
+
refund?: {
|
|
13136
|
+
/** @description Refunded amount. */
|
|
13137
|
+
amount: number;
|
|
13138
|
+
/**
|
|
13139
|
+
* Format: date-time
|
|
13140
|
+
* @description Refund creation timestamp.
|
|
13141
|
+
*/
|
|
13142
|
+
createDate: string;
|
|
13143
|
+
};
|
|
13144
|
+
/** @description Transaction status. */
|
|
13145
|
+
status: string;
|
|
13146
|
+
/**
|
|
13147
|
+
* @deprecated
|
|
13148
|
+
* @description Deprecated. Use product instead.
|
|
13149
|
+
*/
|
|
13150
|
+
ticket?: {
|
|
13151
|
+
/**
|
|
13152
|
+
* Format: date-time
|
|
13153
|
+
* @description Ticket creation timestamp.
|
|
13154
|
+
*/
|
|
13155
|
+
createDate?: string;
|
|
13156
|
+
/** @description Event details. */
|
|
13157
|
+
event?: {
|
|
13158
|
+
/**
|
|
13159
|
+
* Format: date-time
|
|
13160
|
+
* @description Event end date.
|
|
13161
|
+
*/
|
|
13162
|
+
endDate?: string;
|
|
13163
|
+
/**
|
|
13164
|
+
* Format: uuid
|
|
13165
|
+
* @description Event id.
|
|
13166
|
+
*/
|
|
13167
|
+
id: string;
|
|
13168
|
+
/**
|
|
13169
|
+
* Format: date-time
|
|
13170
|
+
* @description Event start date.
|
|
13171
|
+
*/
|
|
13172
|
+
startDate?: string;
|
|
13173
|
+
/** @description Event title. */
|
|
13174
|
+
title: string;
|
|
13175
|
+
};
|
|
13176
|
+
/**
|
|
13177
|
+
* Format: uuid
|
|
13178
|
+
* @description Ticket id.
|
|
13179
|
+
*/
|
|
13180
|
+
id: string;
|
|
13181
|
+
/** @description Number of tickets. */
|
|
13182
|
+
quantity: number;
|
|
13183
|
+
};
|
|
13184
|
+
/**
|
|
13185
|
+
* @description Credits transaction type.
|
|
13186
|
+
* @enum {string}
|
|
13187
|
+
*/
|
|
13188
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "eventTicket" | "expiration" | "order" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
13189
|
+
/** @description User who created the transaction. */
|
|
13190
|
+
userCreatedBy?: {
|
|
13191
|
+
about?: string | null;
|
|
13192
|
+
email?: string | null;
|
|
13193
|
+
/** Format: uuid */
|
|
13194
|
+
id: string;
|
|
13195
|
+
name?: string | null;
|
|
13196
|
+
phoneNumber?: string | null;
|
|
13197
|
+
photoUrl?: string | null;
|
|
13198
|
+
surname?: string | null;
|
|
13199
|
+
};
|
|
13200
|
+
/**
|
|
13201
|
+
* @deprecated
|
|
13202
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13203
|
+
*/
|
|
13204
|
+
userCreator?: {
|
|
13205
|
+
about?: string | null;
|
|
13206
|
+
email?: string | null;
|
|
13207
|
+
/** Format: uuid */
|
|
13208
|
+
id: string;
|
|
13209
|
+
name?: string | null;
|
|
13210
|
+
phoneNumber?: string | null;
|
|
13211
|
+
photoUrl?: string | null;
|
|
13212
|
+
surname?: string | null;
|
|
13213
|
+
};
|
|
13214
|
+
/**
|
|
13215
|
+
* @deprecated
|
|
13216
|
+
* @description Deprecated. Use customer.user instead.
|
|
13217
|
+
*/
|
|
13218
|
+
userOwner?: {
|
|
13219
|
+
about?: string | null;
|
|
13220
|
+
email?: string | null;
|
|
13221
|
+
/** Format: uuid */
|
|
13222
|
+
id: string;
|
|
13223
|
+
name?: string | null;
|
|
13224
|
+
phoneNumber?: string | null;
|
|
13225
|
+
photoUrl?: string | null;
|
|
13226
|
+
surname?: string | null;
|
|
13227
|
+
};
|
|
13228
|
+
/**
|
|
13229
|
+
* Format: uuid
|
|
13230
|
+
* @deprecated
|
|
13231
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13232
|
+
*/
|
|
13233
|
+
userRefCreator?: string;
|
|
13234
|
+
/**
|
|
13235
|
+
* Format: uuid
|
|
13236
|
+
* @deprecated
|
|
13237
|
+
* @description Deprecated. Use customer.user instead.
|
|
13238
|
+
*/
|
|
13239
|
+
userRefOwner?: string;
|
|
13240
|
+
};
|
|
13241
|
+
};
|
|
13242
|
+
transactionCredits: {
|
|
13243
|
+
/** @description Total credits amount (absolute sum of expiring and permanent). */
|
|
13244
|
+
amount: number;
|
|
13245
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
13246
|
+
amounts: {
|
|
13247
|
+
/** @description Amount deducted from this balance bucket. */
|
|
13248
|
+
amount: number;
|
|
13249
|
+
/**
|
|
13250
|
+
* Format: date-time
|
|
13251
|
+
* @description Expiration date for expiring balances.
|
|
13252
|
+
*/
|
|
13253
|
+
expirationDate?: string;
|
|
13254
|
+
/**
|
|
13255
|
+
* Format: uuid
|
|
13256
|
+
* @description Subscription associated with expiring balances.
|
|
13257
|
+
*/
|
|
13258
|
+
subscriptionRef?: string;
|
|
13259
|
+
/**
|
|
13260
|
+
* @description Balance bucket type.
|
|
13261
|
+
* @enum {string}
|
|
13262
|
+
*/
|
|
13263
|
+
type: "expiring" | "permanent";
|
|
13264
|
+
}[];
|
|
13265
|
+
/**
|
|
13266
|
+
* @deprecated
|
|
13267
|
+
* @description Deprecated. Use product instead.
|
|
13268
|
+
*/
|
|
13269
|
+
booking?: {
|
|
13270
|
+
/**
|
|
13271
|
+
* Format: date-time
|
|
13272
|
+
* @description Booking end date.
|
|
13273
|
+
*/
|
|
13274
|
+
endDate?: string;
|
|
13275
|
+
/**
|
|
13276
|
+
* Format: uuid
|
|
13277
|
+
* @description Booking id.
|
|
13278
|
+
*/
|
|
13279
|
+
id: string;
|
|
13280
|
+
/** @description Booked resource. */
|
|
13281
|
+
resource: {
|
|
13282
|
+
/**
|
|
13283
|
+
* Format: uuid
|
|
13284
|
+
* @description Resource id.
|
|
13285
|
+
*/
|
|
13286
|
+
id: string;
|
|
13287
|
+
/** @description Resource title. */
|
|
13288
|
+
title: string;
|
|
13289
|
+
};
|
|
13290
|
+
/**
|
|
13291
|
+
* Format: date-time
|
|
13292
|
+
* @description Booking start date.
|
|
13293
|
+
*/
|
|
13294
|
+
startDate?: string;
|
|
13295
|
+
};
|
|
13296
|
+
/**
|
|
13297
|
+
* @deprecated
|
|
13298
|
+
* @description Deprecated. Use customer instead.
|
|
13299
|
+
*/
|
|
13300
|
+
company?: {
|
|
13301
|
+
/**
|
|
13302
|
+
* Format: date-time
|
|
13303
|
+
* @description ISO timestamp of company creation.
|
|
13304
|
+
*/
|
|
13305
|
+
createDate: string;
|
|
13306
|
+
/**
|
|
13307
|
+
* Format: uuid
|
|
13308
|
+
* @description Company id.
|
|
13309
|
+
*/
|
|
13310
|
+
id: string;
|
|
13311
|
+
/**
|
|
13312
|
+
* Format: uuid
|
|
13313
|
+
* @description Location id.
|
|
13314
|
+
*/
|
|
13315
|
+
locationRef: string;
|
|
13316
|
+
/** @description Company logo. */
|
|
13317
|
+
logo?: {
|
|
13318
|
+
/** @description Storage key of the company logo. */
|
|
13319
|
+
key: string;
|
|
13320
|
+
/** @description Public URL of the company logo. */
|
|
13321
|
+
url: string;
|
|
13322
|
+
};
|
|
13323
|
+
/** @description Company metadata. */
|
|
13324
|
+
metadata?: {
|
|
13325
|
+
[key: string]: unknown;
|
|
13326
|
+
};
|
|
13327
|
+
/** @description Internal notes. */
|
|
13328
|
+
notes?: string;
|
|
13329
|
+
/** @description Public logo URL derived from the company website. */
|
|
13330
|
+
publicLogoUrl?: string;
|
|
13331
|
+
/**
|
|
13332
|
+
* Format: uuid
|
|
13333
|
+
* @description Primary subscription id.
|
|
13334
|
+
*/
|
|
13335
|
+
subscriptionRef: string | null;
|
|
13336
|
+
/** @description Company name. */
|
|
13337
|
+
title: string;
|
|
13338
|
+
};
|
|
13339
|
+
/**
|
|
13340
|
+
* Format: uuid
|
|
13341
|
+
* @deprecated
|
|
13342
|
+
* @description Deprecated. Use customer instead.
|
|
13343
|
+
*/
|
|
13344
|
+
companyRef?: string;
|
|
13345
|
+
/**
|
|
13346
|
+
* Format: date-time
|
|
13347
|
+
* @description ISO timestamp of when the transaction was created.
|
|
13348
|
+
*/
|
|
13349
|
+
createDate: string;
|
|
13350
|
+
/** @description Customer associated with this transaction. */
|
|
13351
|
+
customer: {
|
|
13352
|
+
/**
|
|
13353
|
+
* Format: uuid
|
|
13354
|
+
* @description ID of the company or membership.
|
|
13355
|
+
*/
|
|
13356
|
+
id: string;
|
|
13357
|
+
/** @description Company logo. */
|
|
13358
|
+
logo?: {
|
|
13359
|
+
key: string;
|
|
13360
|
+
url: string;
|
|
13361
|
+
};
|
|
13362
|
+
/** @description Company name. */
|
|
13363
|
+
title?: string;
|
|
13364
|
+
/**
|
|
13365
|
+
* @description Whether the customer is a company or a user.
|
|
13366
|
+
* @enum {string}
|
|
13367
|
+
*/
|
|
13368
|
+
type: "company" | "user";
|
|
13369
|
+
/** @description User details for membership customers. */
|
|
13370
|
+
user?: {
|
|
13371
|
+
about?: string | null;
|
|
13372
|
+
email?: string | null;
|
|
13373
|
+
/** Format: uuid */
|
|
13374
|
+
id: string;
|
|
13375
|
+
name?: string | null;
|
|
13376
|
+
phoneNumber?: string | null;
|
|
13377
|
+
photoUrl?: string | null;
|
|
13378
|
+
surname?: string | null;
|
|
13379
|
+
};
|
|
13380
|
+
};
|
|
13381
|
+
/** @description Transaction description. */
|
|
13382
|
+
description?: string;
|
|
13383
|
+
/** @description Discounts applied to the transaction. */
|
|
13384
|
+
discounts?: {
|
|
13385
|
+
/** @description Applied coupon. */
|
|
13386
|
+
coupon: {
|
|
13387
|
+
/** @description Fixed amount discount. */
|
|
13388
|
+
amountOff?: number;
|
|
13389
|
+
/** @description Currency of the fixed amount discount. */
|
|
13390
|
+
currencyCode?: string;
|
|
13391
|
+
/** @description Coupon id. */
|
|
13392
|
+
id: string;
|
|
13393
|
+
/** @description Percentage discount. */
|
|
13394
|
+
percentOff?: number;
|
|
13395
|
+
/** @description Product types the coupon applies to. */
|
|
13396
|
+
productTypes?: string[];
|
|
13397
|
+
/** @description Coupon type. */
|
|
13398
|
+
type: string;
|
|
13399
|
+
};
|
|
13400
|
+
/** @description Promocode the coupon was applied with. */
|
|
13401
|
+
promocode?: {
|
|
13402
|
+
/** @description Promocode. */
|
|
13403
|
+
code: string;
|
|
13404
|
+
/** @description Promocode expiration date. */
|
|
13405
|
+
expiration?: string;
|
|
13406
|
+
/**
|
|
13407
|
+
* Format: uuid
|
|
13408
|
+
* @description Promocode id.
|
|
13409
|
+
*/
|
|
13410
|
+
id: string;
|
|
13411
|
+
/** @description Whether the promocode is limited to the first purchase. */
|
|
13412
|
+
limitByFirstPurchase?: boolean;
|
|
13413
|
+
};
|
|
13414
|
+
/**
|
|
13415
|
+
* Format: uuid
|
|
13416
|
+
* @description ID of the subscription this discount is associated with.
|
|
13417
|
+
*/
|
|
13418
|
+
subscriptionId?: string;
|
|
13419
|
+
}[];
|
|
13420
|
+
/**
|
|
13421
|
+
* @deprecated
|
|
13422
|
+
* @description Deprecated. Use amounts instead.
|
|
13423
|
+
*/
|
|
13424
|
+
expiringAmount?: number;
|
|
13425
|
+
/**
|
|
13426
|
+
* Format: uuid
|
|
13427
|
+
* @description Unique identifier of the transaction.
|
|
13428
|
+
*/
|
|
13429
|
+
id: string;
|
|
13430
|
+
/**
|
|
13431
|
+
* Format: uuid
|
|
13432
|
+
* @description ID of the organization (location).
|
|
13433
|
+
*/
|
|
13434
|
+
locationRef: string;
|
|
13435
|
+
/**
|
|
13436
|
+
* Format: uuid
|
|
13437
|
+
* @deprecated
|
|
13438
|
+
* @description Deprecated. Use customer instead.
|
|
13439
|
+
*/
|
|
13440
|
+
membershipRef?: string;
|
|
13441
|
+
/**
|
|
13442
|
+
* Format: uuid
|
|
13443
|
+
* @deprecated
|
|
13444
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13445
|
+
*/
|
|
13446
|
+
membershipRefCreator?: string;
|
|
13447
|
+
/**
|
|
13448
|
+
* Format: uuid
|
|
13449
|
+
* @description ID of the network.
|
|
13450
|
+
*/
|
|
13451
|
+
networkRef: string;
|
|
13452
|
+
/**
|
|
13453
|
+
* @deprecated
|
|
13454
|
+
* @description Deprecated. Use product instead.
|
|
13455
|
+
*/
|
|
13456
|
+
order?: {
|
|
13457
|
+
/**
|
|
13458
|
+
* Format: uuid
|
|
13459
|
+
* @description Order id.
|
|
13460
|
+
*/
|
|
13461
|
+
id: string;
|
|
13462
|
+
/** @description Order items. */
|
|
13463
|
+
items: {
|
|
13464
|
+
/**
|
|
13465
|
+
* Format: uuid
|
|
13466
|
+
* @description Order item id.
|
|
13467
|
+
*/
|
|
13468
|
+
id: string;
|
|
13469
|
+
/** @description Ordered product. */
|
|
13470
|
+
product: {
|
|
13471
|
+
/**
|
|
13472
|
+
* Format: uuid
|
|
13473
|
+
* @description Product id.
|
|
13474
|
+
*/
|
|
13475
|
+
id: string;
|
|
13476
|
+
/** @description Product option. */
|
|
13477
|
+
option?: {
|
|
13478
|
+
/**
|
|
13479
|
+
* Format: uuid
|
|
13480
|
+
* @description Product option id.
|
|
13481
|
+
*/
|
|
13482
|
+
id: string;
|
|
13483
|
+
/** @description Product option title. */
|
|
13484
|
+
title: string;
|
|
13485
|
+
};
|
|
13486
|
+
/** @description Product title. */
|
|
13487
|
+
title: string;
|
|
13488
|
+
};
|
|
13489
|
+
/** @description Quantity of units. */
|
|
13490
|
+
quantity: number;
|
|
13491
|
+
}[];
|
|
13492
|
+
};
|
|
13493
|
+
/**
|
|
13494
|
+
* @deprecated
|
|
13495
|
+
* @description Deprecated. Use amounts instead.
|
|
13496
|
+
*/
|
|
13497
|
+
permanentAmount?: number;
|
|
13498
|
+
/** @description Product details. */
|
|
13499
|
+
product?: {
|
|
13500
|
+
/**
|
|
13501
|
+
* Format: uuid
|
|
13502
|
+
* @description ID of the associated booking.
|
|
13503
|
+
*/
|
|
13504
|
+
bookingRef?: string;
|
|
13505
|
+
/**
|
|
13506
|
+
* Format: uuid
|
|
13507
|
+
* @description ID of the associated event ticket.
|
|
13508
|
+
*/
|
|
13509
|
+
eventTicketRef?: string;
|
|
13510
|
+
/**
|
|
13511
|
+
* Format: uuid
|
|
13512
|
+
* @description ID of the associated order.
|
|
13513
|
+
*/
|
|
13514
|
+
orderRef?: string;
|
|
13515
|
+
/** @description Display title of the product. */
|
|
13516
|
+
title?: string;
|
|
13517
|
+
/**
|
|
13518
|
+
* @description Product type.
|
|
13519
|
+
* @enum {string}
|
|
13520
|
+
*/
|
|
13521
|
+
type?: "booking" | "eventTicket" | "order";
|
|
13522
|
+
};
|
|
13523
|
+
/**
|
|
13524
|
+
* @deprecated
|
|
13525
|
+
* @description Deprecated.
|
|
13526
|
+
*/
|
|
13527
|
+
refund?: {
|
|
13528
|
+
/** @description Refunded amount. */
|
|
13529
|
+
amount: number;
|
|
13530
|
+
/**
|
|
13531
|
+
* Format: date-time
|
|
13532
|
+
* @description Refund creation timestamp.
|
|
13533
|
+
*/
|
|
13534
|
+
createDate: string;
|
|
13535
|
+
};
|
|
13536
|
+
/** @description Transaction status. */
|
|
13537
|
+
status: string;
|
|
13538
|
+
/**
|
|
13539
|
+
* @deprecated
|
|
13540
|
+
* @description Deprecated. Use product instead.
|
|
13541
|
+
*/
|
|
12438
13542
|
ticket?: {
|
|
12439
|
-
|
|
13543
|
+
/**
|
|
13544
|
+
* Format: date-time
|
|
13545
|
+
* @description Ticket creation timestamp.
|
|
13546
|
+
*/
|
|
13547
|
+
createDate?: string;
|
|
13548
|
+
/** @description Event details. */
|
|
12440
13549
|
event?: {
|
|
12441
|
-
|
|
12442
|
-
|
|
12443
|
-
|
|
12444
|
-
|
|
12445
|
-
|
|
13550
|
+
/**
|
|
13551
|
+
* Format: date-time
|
|
13552
|
+
* @description Event end date.
|
|
13553
|
+
*/
|
|
13554
|
+
endDate?: string;
|
|
13555
|
+
/**
|
|
13556
|
+
* Format: uuid
|
|
13557
|
+
* @description Event id.
|
|
13558
|
+
*/
|
|
13559
|
+
id: string;
|
|
13560
|
+
/**
|
|
13561
|
+
* Format: date-time
|
|
13562
|
+
* @description Event start date.
|
|
13563
|
+
*/
|
|
13564
|
+
startDate?: string;
|
|
13565
|
+
/** @description Event title. */
|
|
13566
|
+
title: string;
|
|
12446
13567
|
};
|
|
13568
|
+
/**
|
|
13569
|
+
* Format: uuid
|
|
13570
|
+
* @description Ticket id.
|
|
13571
|
+
*/
|
|
13572
|
+
id: string;
|
|
13573
|
+
/** @description Number of tickets. */
|
|
13574
|
+
quantity: number;
|
|
13575
|
+
};
|
|
13576
|
+
/**
|
|
13577
|
+
* @description Credits transaction type.
|
|
13578
|
+
* @enum {string}
|
|
13579
|
+
*/
|
|
13580
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "eventTicket" | "expiration" | "order" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
13581
|
+
/** @description User who created the transaction. */
|
|
13582
|
+
userCreatedBy?: {
|
|
13583
|
+
about?: string | null;
|
|
13584
|
+
email?: string | null;
|
|
12447
13585
|
/** Format: uuid */
|
|
12448
|
-
id
|
|
13586
|
+
id: string;
|
|
13587
|
+
name?: string | null;
|
|
13588
|
+
phoneNumber?: string | null;
|
|
13589
|
+
photoUrl?: string | null;
|
|
13590
|
+
surname?: string | null;
|
|
12449
13591
|
};
|
|
12450
|
-
/**
|
|
12451
|
-
|
|
12452
|
-
|
|
12453
|
-
|
|
12454
|
-
|
|
13592
|
+
/**
|
|
13593
|
+
* @deprecated
|
|
13594
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13595
|
+
*/
|
|
13596
|
+
userCreator?: {
|
|
13597
|
+
about?: string | null;
|
|
13598
|
+
email?: string | null;
|
|
13599
|
+
/** Format: uuid */
|
|
13600
|
+
id: string;
|
|
13601
|
+
name?: string | null;
|
|
13602
|
+
phoneNumber?: string | null;
|
|
13603
|
+
photoUrl?: string | null;
|
|
13604
|
+
surname?: string | null;
|
|
13605
|
+
};
|
|
13606
|
+
/**
|
|
13607
|
+
* @deprecated
|
|
13608
|
+
* @description Deprecated. Use customer.user instead.
|
|
13609
|
+
*/
|
|
13610
|
+
userOwner?: {
|
|
13611
|
+
about?: string | null;
|
|
13612
|
+
email?: string | null;
|
|
13613
|
+
/** Format: uuid */
|
|
13614
|
+
id: string;
|
|
13615
|
+
name?: string | null;
|
|
13616
|
+
phoneNumber?: string | null;
|
|
13617
|
+
photoUrl?: string | null;
|
|
13618
|
+
surname?: string | null;
|
|
13619
|
+
};
|
|
13620
|
+
/**
|
|
13621
|
+
* Format: uuid
|
|
13622
|
+
* @deprecated
|
|
13623
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13624
|
+
*/
|
|
12455
13625
|
userRefCreator?: string;
|
|
12456
|
-
/**
|
|
13626
|
+
/**
|
|
13627
|
+
* Format: uuid
|
|
13628
|
+
* @deprecated
|
|
13629
|
+
* @description Deprecated. Use customer.user instead.
|
|
13630
|
+
*/
|
|
12457
13631
|
userRefOwner?: string;
|
|
12458
13632
|
};
|
|
12459
|
-
transactionCredits: {
|
|
12460
|
-
amount?: number;
|
|
12461
|
-
company?: components["schemas"]["company"];
|
|
12462
|
-
/** Format: uuid */
|
|
12463
|
-
companyRef?: string;
|
|
12464
|
-
createDate?: components["schemas"]["dateSchema"];
|
|
12465
|
-
/** @description The memo of the transaction. */
|
|
12466
|
-
description?: string;
|
|
12467
|
-
/** Format: uuid */
|
|
12468
|
-
id?: string;
|
|
12469
|
-
/** Format: uuid */
|
|
12470
|
-
locationRef?: string;
|
|
12471
|
-
/** Format: uuid */
|
|
12472
|
-
membershipRef?: string;
|
|
12473
|
-
/** Format: uuid */
|
|
12474
|
-
membershipRefCreator?: string;
|
|
12475
|
-
/** @enum {string} */
|
|
12476
|
-
status?: "canceled" | "failed" | "succeeded";
|
|
12477
|
-
/** @enum {string} */
|
|
12478
|
-
type?: "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
12479
|
-
userCreator?: components["schemas"]["user"];
|
|
12480
|
-
userOwner?: components["schemas"]["user"];
|
|
12481
|
-
/** Format: uuid */
|
|
12482
|
-
userRef?: string;
|
|
12483
|
-
/** Format: uuid */
|
|
12484
|
-
userRefCreator?: string;
|
|
12485
|
-
};
|
|
12486
13633
|
getScheduledDayPassesTransactions: {
|
|
12487
13634
|
/** @description Pagination token to fetch the next page of results. Returned when more results exist. */
|
|
12488
13635
|
nextPageToken?: string;
|
|
@@ -12729,6 +13876,8 @@ interface components {
|
|
|
12729
13876
|
getDayPassesTransactions: {
|
|
12730
13877
|
/** @description Pagination token to fetch the next page of results. */
|
|
12731
13878
|
nextPageToken?: string;
|
|
13879
|
+
/** @description Ready-to-use query string with the current filters and nextPageToken to fetch the next page of results. */
|
|
13880
|
+
searchQueryNext?: string;
|
|
12732
13881
|
/** @description List of day pass transactions. */
|
|
12733
13882
|
transactions: {
|
|
12734
13883
|
/** @description Total day pass amount (absolute sum of expiring and permanent). */
|
|
@@ -15175,6 +16324,10 @@ interface components {
|
|
|
15175
16324
|
* @enum {string}
|
|
15176
16325
|
*/
|
|
15177
16326
|
visibility: "public" | "admins" | "members" | "networkMembers";
|
|
16327
|
+
/** @description Storage keys of uploaded files to attach to the guide. */
|
|
16328
|
+
attachments?: {
|
|
16329
|
+
key: string;
|
|
16330
|
+
}[];
|
|
15178
16331
|
};
|
|
15179
16332
|
};
|
|
15180
16333
|
};
|
|
@@ -15193,6 +16346,10 @@ interface components {
|
|
|
15193
16346
|
* @enum {string}
|
|
15194
16347
|
*/
|
|
15195
16348
|
visibility?: "public" | "admins" | "members" | "networkMembers";
|
|
16349
|
+
/** @description Storage keys of uploaded files to attach to the guide. */
|
|
16350
|
+
attachments?: {
|
|
16351
|
+
key: string;
|
|
16352
|
+
}[];
|
|
15196
16353
|
};
|
|
15197
16354
|
};
|
|
15198
16355
|
};
|
|
@@ -17366,28 +18523,42 @@ interface components {
|
|
|
17366
18523
|
createCreditsTransaction: {
|
|
17367
18524
|
content: {
|
|
17368
18525
|
"application/json": {
|
|
18526
|
+
/** @description Credits transaction to create. */
|
|
17369
18527
|
transaction: {
|
|
18528
|
+
/** @description Credits amount. Must be greater than zero. */
|
|
17370
18529
|
amount: number;
|
|
17371
18530
|
/**
|
|
17372
18531
|
* Format: uuid
|
|
17373
|
-
* @
|
|
18532
|
+
* @deprecated
|
|
18533
|
+
* @description Deprecated. Use customerRef instead.
|
|
17374
18534
|
*/
|
|
17375
18535
|
companyRef?: string;
|
|
17376
|
-
/**
|
|
18536
|
+
/**
|
|
18537
|
+
* Format: uuid
|
|
18538
|
+
* @description The company or membership id to charge or transfer credits to or from.
|
|
18539
|
+
*/
|
|
18540
|
+
customerRef?: string;
|
|
18541
|
+
/** @description Description of the transaction. */
|
|
17377
18542
|
description?: string;
|
|
18543
|
+
/** @description Expiration date for expiring credits. */
|
|
18544
|
+
expirationDate?: string;
|
|
17378
18545
|
/**
|
|
17379
18546
|
* Format: uuid
|
|
17380
|
-
* @description The location id where to create
|
|
18547
|
+
* @description The location id where to create the transaction.
|
|
17381
18548
|
*/
|
|
17382
18549
|
locationRef: string;
|
|
17383
18550
|
/**
|
|
17384
18551
|
* Format: uuid
|
|
17385
|
-
* @
|
|
18552
|
+
* @deprecated
|
|
18553
|
+
* @description Deprecated. Use customerRef instead.
|
|
17386
18554
|
*/
|
|
17387
18555
|
membershipRef?: string;
|
|
17388
|
-
/**
|
|
17389
|
-
|
|
17390
|
-
|
|
18556
|
+
/**
|
|
18557
|
+
* @description Transaction type. chargeExpiringCredits, chargePermanentCredits, transferExpiringCredits, and transferPermanentCredits are deprecated; use adminCharge or adminAllocation instead.
|
|
18558
|
+
* @enum {string}
|
|
18559
|
+
*/
|
|
18560
|
+
type: "adminAllocation" | "adminCharge" | "chargeExpiringCredits" | "chargePermanentCredits" | "transferExpiringCredits" | "transferPermanentCredits";
|
|
18561
|
+
};
|
|
17391
18562
|
};
|
|
17392
18563
|
};
|
|
17393
18564
|
};
|
|
@@ -20820,13 +21991,29 @@ interface operations {
|
|
|
20820
21991
|
};
|
|
20821
21992
|
getEventTickets: {
|
|
20822
21993
|
parameters: {
|
|
20823
|
-
query
|
|
20824
|
-
/** @description
|
|
20825
|
-
|
|
20826
|
-
/** @description
|
|
21994
|
+
query?: {
|
|
21995
|
+
/** @description UUID of the customer whose event tickets to list. */
|
|
21996
|
+
customerRef?: string;
|
|
21997
|
+
/** @description UUID of the event whose tickets to list. */
|
|
21998
|
+
eventRef?: string;
|
|
21999
|
+
/** @description Deprecated. Use status "canceled" instead. Set to "true" to include deleted event tickets. */
|
|
22000
|
+
includeDeleted?: string;
|
|
22001
|
+
/** @description Maximum number of event tickets per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
20827
22002
|
limit?: number;
|
|
20828
|
-
/** @description
|
|
20829
|
-
|
|
22003
|
+
/** @description UUID of the location whose event tickets to list. */
|
|
22004
|
+
locationRef?: string;
|
|
22005
|
+
/** @description Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
22006
|
+
nextPageToken?: string;
|
|
22007
|
+
/**
|
|
22008
|
+
* @description Filter by event ticket status. Comma-separated values, e.g. `active,canceled`. Defaults to `active` when omitted.
|
|
22009
|
+
*
|
|
22010
|
+
* Supported values:
|
|
22011
|
+
* - **active** — the ticket is valid
|
|
22012
|
+
* - **canceled** — the ticket was deleted
|
|
22013
|
+
*/
|
|
22014
|
+
status?: string;
|
|
22015
|
+
/** @description UUID of the user whose event tickets to list. */
|
|
22016
|
+
userRef?: string;
|
|
20830
22017
|
};
|
|
20831
22018
|
header?: {
|
|
20832
22019
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -23713,29 +24900,26 @@ interface operations {
|
|
|
23713
24900
|
getCreditsTransactions: {
|
|
23714
24901
|
parameters: {
|
|
23715
24902
|
query?: {
|
|
23716
|
-
/** @description The
|
|
24903
|
+
/** @description Deprecated. Use customerRef instead. The id of the company to get transactions for. */
|
|
24904
|
+
companyRef?: string;
|
|
24905
|
+
/** @description Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
24906
|
+
"createDate[gte]"?: string;
|
|
24907
|
+
/** @description Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
24908
|
+
"createDate[lte]"?: string;
|
|
24909
|
+
/** @description UUID of the company or membership whose credits transactions to list. */
|
|
24910
|
+
customerRef?: string;
|
|
24911
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
23717
24912
|
limit?: number;
|
|
23718
|
-
/** @description
|
|
23719
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
23720
|
-
/** @description The date filter of items. */
|
|
23721
|
-
createDate?: {
|
|
23722
|
-
/**
|
|
23723
|
-
* Format: date-time
|
|
23724
|
-
* @description Get transactions with less createDate. Example: createDate[lte]=2021-05-21T10:00:00Z
|
|
23725
|
-
*/
|
|
23726
|
-
lte?: string;
|
|
23727
|
-
/**
|
|
23728
|
-
* Format: date-time
|
|
23729
|
-
* @description Get transactions with greater createDate. Example: createDate[gte]=2021-05-21T10:00:00Z
|
|
23730
|
-
*/
|
|
23731
|
-
gte?: string;
|
|
23732
|
-
};
|
|
23733
|
-
/** @description The id of the location to get transactions for */
|
|
24913
|
+
/** @description UUID of the location whose credits transactions to list. */
|
|
23734
24914
|
locationRef?: string;
|
|
23735
|
-
/** @description The id of the membership to get transactions for */
|
|
24915
|
+
/** @description Deprecated. Use customerRef instead. The id of the membership to get transactions for. */
|
|
23736
24916
|
membershipRef?: string;
|
|
23737
|
-
/** @description
|
|
23738
|
-
|
|
24917
|
+
/** @description Token to retrieve the next page of results. */
|
|
24918
|
+
nextPageToken?: string;
|
|
24919
|
+
/** @description Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
24920
|
+
status?: string;
|
|
24921
|
+
/** @description Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
|
|
24922
|
+
type?: string;
|
|
23739
24923
|
};
|
|
23740
24924
|
header?: {
|
|
23741
24925
|
/** @description The id of the network. Required when using bearer token authentication */
|
|
@@ -23752,10 +24936,7 @@ interface operations {
|
|
|
23752
24936
|
[name: string]: unknown;
|
|
23753
24937
|
};
|
|
23754
24938
|
content: {
|
|
23755
|
-
"application/json":
|
|
23756
|
-
transactions?: components["schemas"]["transactionCreditsExpanded"][];
|
|
23757
|
-
nextPageToken?: components["schemas"]["nextPageToken"];
|
|
23758
|
-
};
|
|
24939
|
+
"application/json": components["schemas"]["getCreditsTransactions"];
|
|
23759
24940
|
};
|
|
23760
24941
|
};
|
|
23761
24942
|
/** @description Bad Request */
|
|
@@ -23783,6 +24964,41 @@ interface operations {
|
|
|
23783
24964
|
responses: {
|
|
23784
24965
|
/** @description Created */
|
|
23785
24966
|
201: {
|
|
24967
|
+
headers: {
|
|
24968
|
+
[name: string]: unknown;
|
|
24969
|
+
};
|
|
24970
|
+
content: {
|
|
24971
|
+
"application/json": components["schemas"]["createCreditsTransaction"];
|
|
24972
|
+
};
|
|
24973
|
+
};
|
|
24974
|
+
/** @description Bad Request */
|
|
24975
|
+
400: {
|
|
24976
|
+
headers: {
|
|
24977
|
+
[name: string]: unknown;
|
|
24978
|
+
};
|
|
24979
|
+
content: {
|
|
24980
|
+
"application/json": components["schemas"]["responseError"];
|
|
24981
|
+
};
|
|
24982
|
+
};
|
|
24983
|
+
};
|
|
24984
|
+
};
|
|
24985
|
+
getCreditsTransaction: {
|
|
24986
|
+
parameters: {
|
|
24987
|
+
query?: never;
|
|
24988
|
+
header?: {
|
|
24989
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
24990
|
+
"spacebring-network-id"?: string;
|
|
24991
|
+
};
|
|
24992
|
+
path: {
|
|
24993
|
+
/** @description The id of the transaction */
|
|
24994
|
+
id: string;
|
|
24995
|
+
};
|
|
24996
|
+
cookie?: never;
|
|
24997
|
+
};
|
|
24998
|
+
requestBody?: never;
|
|
24999
|
+
responses: {
|
|
25000
|
+
/** @description OK */
|
|
25001
|
+
200: {
|
|
23786
25002
|
headers: {
|
|
23787
25003
|
[name: string]: unknown;
|
|
23788
25004
|
};
|
|
@@ -24805,7 +26021,7 @@ type UpdateVisitBody = NonNullable<NonNullable<operations["updateVisit"]["reques
|
|
|
24805
26021
|
/** A Balance entity as returned by the Spacebring API. */
|
|
24806
26022
|
type Balance = NonNullable<components["schemas"]["balance"]>;
|
|
24807
26023
|
/** A CreditTransaction entity as returned by the Spacebring API. */
|
|
24808
|
-
type CreditTransaction = NonNullable<components["schemas"]["
|
|
26024
|
+
type CreditTransaction = NonNullable<components["schemas"]["transactionCredits"]>;
|
|
24809
26025
|
/** A DayPassTransaction entity as returned by the Spacebring API. */
|
|
24810
26026
|
type DayPassTransaction = NonNullable<components["schemas"]["transactionDayPasses"]>;
|
|
24811
26027
|
/** A MoneyTransaction entity as returned by the Spacebring API. */
|
|
@@ -24814,21 +26030,26 @@ type MoneyTransaction = NonNullable<components["schemas"]["transaction"]>;
|
|
|
24814
26030
|
type ScheduledTransaction = NonNullable<operations["getScheduledDayPassesTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
24815
26031
|
/** Query parameters for `sb.transactions.credits.list()`. */
|
|
24816
26032
|
interface GetCreditsTransactionsQuery {
|
|
24817
|
-
/** The
|
|
26033
|
+
/** @deprecated Use customerRef instead. The id of the company to get transactions for. */
|
|
26034
|
+
companyRef?: string;
|
|
26035
|
+
/** Get transactions with greater or equal createDate. Example: createDate[gte]=2021-05-21T10:00:00Z */
|
|
26036
|
+
"createDate[gte]"?: string;
|
|
26037
|
+
/** Get transactions with less or equal createDate. Example: createDate[lte]=2021-05-21T10:00:00Z */
|
|
26038
|
+
"createDate[lte]"?: string;
|
|
26039
|
+
/** UUID of the company or membership whose credits transactions to list. */
|
|
26040
|
+
customerRef?: string;
|
|
26041
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
24818
26042
|
limit?: number;
|
|
24819
|
-
/**
|
|
24820
|
-
nextPageToken?: string;
|
|
24821
|
-
/** The date filter of items. */
|
|
24822
|
-
createDate?: {
|
|
24823
|
-
lte?: string;
|
|
24824
|
-
gte?: string;
|
|
24825
|
-
};
|
|
24826
|
-
/** The id of the location to get transactions for */
|
|
26043
|
+
/** UUID of the location whose credits transactions to list. */
|
|
24827
26044
|
locationRef?: string;
|
|
24828
|
-
/** The id of the membership to get transactions for */
|
|
26045
|
+
/** @deprecated Use customerRef instead. The id of the membership to get transactions for. */
|
|
24829
26046
|
membershipRef?: string;
|
|
24830
|
-
/**
|
|
24831
|
-
|
|
26047
|
+
/** Token to retrieve the next page of results. */
|
|
26048
|
+
nextPageToken?: string;
|
|
26049
|
+
/** Filter by transaction status. Comma-separated status values, e.g. `status=succeeded,pending`. */
|
|
26050
|
+
status?: string;
|
|
26051
|
+
/** Filter by transaction type. Comma-separated storage type values, e.g. `type=refund,booking`. Matches analytics report type filters. */
|
|
26052
|
+
type?: string;
|
|
24832
26053
|
}
|
|
24833
26054
|
/** Query parameters for `sb.transactions.dayPasses.list()`. */
|
|
24834
26055
|
interface GetDayPassesTransactionsQuery {
|
|
@@ -25193,12 +26414,26 @@ interface GetEventsByOrganizationQuery {
|
|
|
25193
26414
|
}
|
|
25194
26415
|
/** Query parameters for `sb.events.tickets.list()`. */
|
|
25195
26416
|
interface GetEventTicketsQuery {
|
|
25196
|
-
/**
|
|
25197
|
-
|
|
25198
|
-
/**
|
|
26417
|
+
/** UUID of the customer whose event tickets to list. */
|
|
26418
|
+
customerRef?: string;
|
|
26419
|
+
/** UUID of the event whose tickets to list. */
|
|
26420
|
+
eventRef?: string;
|
|
26421
|
+
/** @deprecated Use status "canceled" instead. Set to "true" to include deleted event tickets. */
|
|
26422
|
+
includeDeleted?: string;
|
|
26423
|
+
/** Maximum number of event tickets per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
25199
26424
|
limit?: number;
|
|
25200
|
-
/**
|
|
26425
|
+
/** UUID of the location whose event tickets to list. */
|
|
26426
|
+
locationRef?: string;
|
|
26427
|
+
/** Pagination token from nextPageToken in a previous response. Keep the same filters when fetching the next page. */
|
|
25201
26428
|
nextPageToken?: string;
|
|
26429
|
+
/** Filter by event ticket status. Comma-separated values, e.g. `active,canceled`. Defaults to `active` when omitted.
|
|
26430
|
+
|
|
26431
|
+
Supported values:
|
|
26432
|
+
- **active** — the ticket is valid
|
|
26433
|
+
- **canceled** — the ticket was deleted */
|
|
26434
|
+
status?: string;
|
|
26435
|
+
/** UUID of the user whose event tickets to list. */
|
|
26436
|
+
userRef?: string;
|
|
25202
26437
|
}
|
|
25203
26438
|
/** Request body for `sb.events.addEventHosts()`. */
|
|
25204
26439
|
type AddEventHostsBody = NonNullable<NonNullable<operations["addEventHosts"]["requestBody"]>["content"]["application/json"]["tickets"]>;
|
|
@@ -25751,12 +26986,12 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
25751
26986
|
cancel(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
25752
26987
|
copy(id: string, options?: SpacebringRequestOptions): Promise<Event>;
|
|
25753
26988
|
tickets: {
|
|
25754
|
-
list(query
|
|
26989
|
+
list(query?: GetEventTicketsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
25755
26990
|
tickets?: EventTicket[];
|
|
25756
26991
|
nextPageToken?: string;
|
|
25757
26992
|
searchQueryNext?: string;
|
|
25758
26993
|
}>;
|
|
25759
|
-
iterate(query
|
|
26994
|
+
iterate(query?: Omit<GetEventTicketsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<EventTicket, void, undefined>;
|
|
25760
26995
|
get(id: string, options?: SpacebringRequestOptions): Promise<EventTicket>;
|
|
25761
26996
|
update(id: string, ticket: UpdateEventTicketBody, options?: SpacebringRequestOptions): Promise<EventTicket>;
|
|
25762
26997
|
delete(id: string, options?: SpacebringRequestOptions): Promise<EventTicket>;
|
|
@@ -25947,15 +27182,18 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
25947
27182
|
};
|
|
25948
27183
|
credits: {
|
|
25949
27184
|
list(query?: GetCreditsTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
25950
|
-
transactions?: CreditTransaction[];
|
|
25951
27185
|
nextPageToken?: string;
|
|
27186
|
+
searchQueryNext?: string;
|
|
27187
|
+
transactions: CreditTransaction[];
|
|
25952
27188
|
}>;
|
|
25953
27189
|
iterate(query?: Omit<GetCreditsTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<CreditTransaction, void, undefined>;
|
|
27190
|
+
get(id: string, options?: SpacebringRequestOptions): Promise<CreditTransaction>;
|
|
25954
27191
|
create(transaction: CreateCreditsTransactionBody, options?: SpacebringRequestOptions): Promise<CreditTransaction>;
|
|
25955
27192
|
};
|
|
25956
27193
|
dayPasses: {
|
|
25957
27194
|
list(query?: GetDayPassesTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
25958
27195
|
nextPageToken?: string;
|
|
27196
|
+
searchQueryNext?: string;
|
|
25959
27197
|
transactions: DayPassTransaction[];
|
|
25960
27198
|
}>;
|
|
25961
27199
|
iterate(query?: Omit<GetDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<DayPassTransaction, void, undefined>;
|