@izak0s/spacebring-api 2.1.0 → 3.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.cjs +32 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +672 -32
- package/dist/index.d.ts +672 -32
- package/dist/index.js +32 -0
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -2439,6 +2439,26 @@ interface paths {
|
|
|
2439
2439
|
patch?: never;
|
|
2440
2440
|
trace?: never;
|
|
2441
2441
|
};
|
|
2442
|
+
"/transactions/day_passes/scheduled/v1": {
|
|
2443
|
+
parameters: {
|
|
2444
|
+
query?: never;
|
|
2445
|
+
header?: never;
|
|
2446
|
+
path?: never;
|
|
2447
|
+
cookie?: never;
|
|
2448
|
+
};
|
|
2449
|
+
/**
|
|
2450
|
+
* Retrieve scheduled day pass transactions
|
|
2451
|
+
* @description Retrieve scheduled day passes transactions of a subscription or a customer. <h3>OAuth</h3>Required scopes: <code>transactions.readonly</code> or <code>transactions</code>
|
|
2452
|
+
*/
|
|
2453
|
+
get: operations["getScheduledDayPassesTransactions"];
|
|
2454
|
+
put?: never;
|
|
2455
|
+
post?: never;
|
|
2456
|
+
delete?: never;
|
|
2457
|
+
options?: never;
|
|
2458
|
+
head?: never;
|
|
2459
|
+
patch?: never;
|
|
2460
|
+
trace?: never;
|
|
2461
|
+
};
|
|
2442
2462
|
"/transactions/day_passes/v1": {
|
|
2443
2463
|
parameters: {
|
|
2444
2464
|
query?: never;
|
|
@@ -2463,6 +2483,26 @@ interface paths {
|
|
|
2463
2483
|
patch?: never;
|
|
2464
2484
|
trace?: never;
|
|
2465
2485
|
};
|
|
2486
|
+
"/transactions/day_passes/v1/{id}": {
|
|
2487
|
+
parameters: {
|
|
2488
|
+
query?: never;
|
|
2489
|
+
header?: never;
|
|
2490
|
+
path?: never;
|
|
2491
|
+
cookie?: never;
|
|
2492
|
+
};
|
|
2493
|
+
/**
|
|
2494
|
+
* Retrieve a day pass transaction
|
|
2495
|
+
* @description Retrieve a day passes transaction. <h3>OAuth</h3>Required scopes: <code>transactions.readonly</code> or <code>transactions</code>
|
|
2496
|
+
*/
|
|
2497
|
+
get: operations["getDayPassesTransaction"];
|
|
2498
|
+
put?: never;
|
|
2499
|
+
post?: never;
|
|
2500
|
+
delete?: never;
|
|
2501
|
+
options?: never;
|
|
2502
|
+
head?: never;
|
|
2503
|
+
patch?: never;
|
|
2504
|
+
trace?: never;
|
|
2505
|
+
};
|
|
2466
2506
|
"/transactions/money/v1": {
|
|
2467
2507
|
parameters: {
|
|
2468
2508
|
query?: never;
|
|
@@ -12276,6 +12316,249 @@ interface components {
|
|
|
12276
12316
|
/** Format: uuid */
|
|
12277
12317
|
userRefCreator?: string;
|
|
12278
12318
|
};
|
|
12319
|
+
getScheduledDayPassesTransactions: {
|
|
12320
|
+
/** @description Pagination token to fetch the next page of results. Returned when more results exist. */
|
|
12321
|
+
nextPageToken?: string;
|
|
12322
|
+
/** @description List of scheduled day pass transactions. */
|
|
12323
|
+
scheduledTransactions: {
|
|
12324
|
+
/** @description Total day pass amount (absolute sum of expiring and permanent). */
|
|
12325
|
+
amount: number;
|
|
12326
|
+
/**
|
|
12327
|
+
* @deprecated
|
|
12328
|
+
* @description Deprecated. Use product instead.
|
|
12329
|
+
*/
|
|
12330
|
+
booking?: {
|
|
12331
|
+
/**
|
|
12332
|
+
* Format: uuid
|
|
12333
|
+
* @description Booking id.
|
|
12334
|
+
*/
|
|
12335
|
+
id: string;
|
|
12336
|
+
/** @description Booked resource. */
|
|
12337
|
+
resource: {
|
|
12338
|
+
/**
|
|
12339
|
+
* Format: uuid
|
|
12340
|
+
* @description Resource id.
|
|
12341
|
+
*/
|
|
12342
|
+
id: string;
|
|
12343
|
+
/** @description Resource title. */
|
|
12344
|
+
title: string;
|
|
12345
|
+
};
|
|
12346
|
+
};
|
|
12347
|
+
/**
|
|
12348
|
+
* @deprecated
|
|
12349
|
+
* @description Deprecated. Use customer instead.
|
|
12350
|
+
*/
|
|
12351
|
+
company?: {
|
|
12352
|
+
/**
|
|
12353
|
+
* Format: date-time
|
|
12354
|
+
* @description ISO timestamp of company creation.
|
|
12355
|
+
*/
|
|
12356
|
+
createDate: string;
|
|
12357
|
+
/**
|
|
12358
|
+
* Format: uuid
|
|
12359
|
+
* @description Company id.
|
|
12360
|
+
*/
|
|
12361
|
+
id: string;
|
|
12362
|
+
/**
|
|
12363
|
+
* Format: uuid
|
|
12364
|
+
* @description Location id.
|
|
12365
|
+
*/
|
|
12366
|
+
locationRef: string;
|
|
12367
|
+
/** @description Company logo. */
|
|
12368
|
+
logo?: {
|
|
12369
|
+
/** @description Storage key of the company logo. */
|
|
12370
|
+
key: string;
|
|
12371
|
+
/** @description Public URL of the company logo. */
|
|
12372
|
+
url: string;
|
|
12373
|
+
};
|
|
12374
|
+
/** @description Company metadata. */
|
|
12375
|
+
metadata?: {
|
|
12376
|
+
[key: string]: unknown;
|
|
12377
|
+
};
|
|
12378
|
+
/** @description Internal notes. */
|
|
12379
|
+
notes?: string;
|
|
12380
|
+
/** @description Public logo URL derived from the company website. */
|
|
12381
|
+
publicLogoUrl?: string;
|
|
12382
|
+
/**
|
|
12383
|
+
* Format: uuid
|
|
12384
|
+
* @description Primary subscription id.
|
|
12385
|
+
*/
|
|
12386
|
+
subscriptionRef: string | null;
|
|
12387
|
+
/** @description Company name. */
|
|
12388
|
+
title: string;
|
|
12389
|
+
};
|
|
12390
|
+
/**
|
|
12391
|
+
* Format: uuid
|
|
12392
|
+
* @deprecated
|
|
12393
|
+
* @description Deprecated. Use customer instead.
|
|
12394
|
+
*/
|
|
12395
|
+
companyRef?: string;
|
|
12396
|
+
/**
|
|
12397
|
+
* Format: date-time
|
|
12398
|
+
* @description ISO timestamp of when the scheduled transaction was created.
|
|
12399
|
+
*/
|
|
12400
|
+
createDate: string;
|
|
12401
|
+
/** @description Customer associated with this scheduled transaction. */
|
|
12402
|
+
customer: {
|
|
12403
|
+
/**
|
|
12404
|
+
* Format: uuid
|
|
12405
|
+
* @description ID of the company or membership.
|
|
12406
|
+
*/
|
|
12407
|
+
id: string;
|
|
12408
|
+
/** @description Company logo. */
|
|
12409
|
+
logo?: {
|
|
12410
|
+
key: string;
|
|
12411
|
+
url: string;
|
|
12412
|
+
};
|
|
12413
|
+
/** @description Company name. */
|
|
12414
|
+
title?: string;
|
|
12415
|
+
/**
|
|
12416
|
+
* @description Whether the customer is a company or a user.
|
|
12417
|
+
* @enum {string}
|
|
12418
|
+
*/
|
|
12419
|
+
type: "company" | "user";
|
|
12420
|
+
/** @description User details for membership customers. */
|
|
12421
|
+
user?: {
|
|
12422
|
+
about?: string | null;
|
|
12423
|
+
email?: string | null;
|
|
12424
|
+
/** Format: uuid */
|
|
12425
|
+
id: string;
|
|
12426
|
+
name?: string | null;
|
|
12427
|
+
phoneNumber?: string | null;
|
|
12428
|
+
photoUrl?: string | null;
|
|
12429
|
+
surname?: string | null;
|
|
12430
|
+
};
|
|
12431
|
+
};
|
|
12432
|
+
/**
|
|
12433
|
+
* Format: uuid
|
|
12434
|
+
* @description Unique identifier of the scheduled transaction.
|
|
12435
|
+
*/
|
|
12436
|
+
id: string;
|
|
12437
|
+
/**
|
|
12438
|
+
* Format: uuid
|
|
12439
|
+
* @description ID of the organization (location).
|
|
12440
|
+
*/
|
|
12441
|
+
locationRef: string;
|
|
12442
|
+
/**
|
|
12443
|
+
* Format: uuid
|
|
12444
|
+
* @deprecated
|
|
12445
|
+
* @description Deprecated. Use customer instead.
|
|
12446
|
+
*/
|
|
12447
|
+
membershipRef?: string;
|
|
12448
|
+
/**
|
|
12449
|
+
* Format: uuid
|
|
12450
|
+
* @deprecated
|
|
12451
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12452
|
+
*/
|
|
12453
|
+
membershipRefCreator?: string;
|
|
12454
|
+
/**
|
|
12455
|
+
* Format: uuid
|
|
12456
|
+
* @description ID of the network.
|
|
12457
|
+
*/
|
|
12458
|
+
networkRef: string;
|
|
12459
|
+
/** @description Product details. */
|
|
12460
|
+
product?: {
|
|
12461
|
+
/**
|
|
12462
|
+
* Format: uuid
|
|
12463
|
+
* @description ID of the associated booking.
|
|
12464
|
+
*/
|
|
12465
|
+
bookingRef?: string;
|
|
12466
|
+
/** @description Display title of the product. */
|
|
12467
|
+
title: string;
|
|
12468
|
+
/**
|
|
12469
|
+
* @description Product type.
|
|
12470
|
+
* @enum {string}
|
|
12471
|
+
*/
|
|
12472
|
+
type: "booking";
|
|
12473
|
+
};
|
|
12474
|
+
/**
|
|
12475
|
+
* Format: date-time
|
|
12476
|
+
* @description ISO timestamp of when the scheduled transaction was resolved into a day pass transaction.
|
|
12477
|
+
*/
|
|
12478
|
+
resolveDate?: string;
|
|
12479
|
+
/**
|
|
12480
|
+
* Format: date-time
|
|
12481
|
+
* @description Date when the transaction is scheduled to resolve, anchored to the subscription interval the booking falls into.
|
|
12482
|
+
*/
|
|
12483
|
+
scheduleDate: string;
|
|
12484
|
+
/** @description Transaction status. */
|
|
12485
|
+
status: string;
|
|
12486
|
+
/** @description Timezone of the subscription. */
|
|
12487
|
+
timezoneId: string;
|
|
12488
|
+
/**
|
|
12489
|
+
* @description Scheduled day pass transaction type.
|
|
12490
|
+
* @enum {string}
|
|
12491
|
+
*/
|
|
12492
|
+
type: "booking";
|
|
12493
|
+
/**
|
|
12494
|
+
* @deprecated
|
|
12495
|
+
* @description Deprecated. Use userOwner instead.
|
|
12496
|
+
*/
|
|
12497
|
+
user?: {
|
|
12498
|
+
about?: string | null;
|
|
12499
|
+
email?: string | null;
|
|
12500
|
+
/** Format: uuid */
|
|
12501
|
+
id: string;
|
|
12502
|
+
name?: string | null;
|
|
12503
|
+
phoneNumber?: string | null;
|
|
12504
|
+
photoUrl?: string | null;
|
|
12505
|
+
surname?: string | null;
|
|
12506
|
+
};
|
|
12507
|
+
/** @description User who created the transaction. */
|
|
12508
|
+
userCreatedBy?: {
|
|
12509
|
+
about?: string | null;
|
|
12510
|
+
email?: string | null;
|
|
12511
|
+
/** Format: uuid */
|
|
12512
|
+
id: string;
|
|
12513
|
+
name?: string | null;
|
|
12514
|
+
phoneNumber?: string | null;
|
|
12515
|
+
photoUrl?: string | null;
|
|
12516
|
+
surname?: string | null;
|
|
12517
|
+
};
|
|
12518
|
+
/**
|
|
12519
|
+
* @deprecated
|
|
12520
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12521
|
+
*/
|
|
12522
|
+
userCreator?: {
|
|
12523
|
+
about?: string | null;
|
|
12524
|
+
email?: string | null;
|
|
12525
|
+
/** Format: uuid */
|
|
12526
|
+
id: string;
|
|
12527
|
+
name?: string | null;
|
|
12528
|
+
phoneNumber?: string | null;
|
|
12529
|
+
photoUrl?: string | null;
|
|
12530
|
+
surname?: string | null;
|
|
12531
|
+
};
|
|
12532
|
+
/**
|
|
12533
|
+
* @deprecated
|
|
12534
|
+
* @description Deprecated. Use customer.user instead.
|
|
12535
|
+
*/
|
|
12536
|
+
userOwner?: {
|
|
12537
|
+
about?: string | null;
|
|
12538
|
+
email?: string | null;
|
|
12539
|
+
/** Format: uuid */
|
|
12540
|
+
id: string;
|
|
12541
|
+
name?: string | null;
|
|
12542
|
+
phoneNumber?: string | null;
|
|
12543
|
+
photoUrl?: string | null;
|
|
12544
|
+
surname?: string | null;
|
|
12545
|
+
};
|
|
12546
|
+
/**
|
|
12547
|
+
* Format: uuid
|
|
12548
|
+
* @deprecated
|
|
12549
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
12550
|
+
*/
|
|
12551
|
+
userRefCreator?: string;
|
|
12552
|
+
/**
|
|
12553
|
+
* Format: uuid
|
|
12554
|
+
* @deprecated
|
|
12555
|
+
* @description Deprecated. Use customer.user instead.
|
|
12556
|
+
*/
|
|
12557
|
+
userRefOwner?: string;
|
|
12558
|
+
}[];
|
|
12559
|
+
/** @description Query string with nextPageToken and the request filter to fetch the next page of results. Returned when more results exist. */
|
|
12560
|
+
searchQueryNext?: string;
|
|
12561
|
+
};
|
|
12279
12562
|
getDayPassesTransactions: {
|
|
12280
12563
|
/** @description Pagination token to fetch the next page of results. */
|
|
12281
12564
|
nextPageToken?: string;
|
|
@@ -12761,24 +13044,166 @@ interface components {
|
|
|
12761
13044
|
surname?: string | null;
|
|
12762
13045
|
};
|
|
12763
13046
|
/**
|
|
12764
|
-
* @deprecated
|
|
12765
|
-
* @description Deprecated. Use userCreatedBy instead.
|
|
13047
|
+
* @deprecated
|
|
13048
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13049
|
+
*/
|
|
13050
|
+
userCreator?: {
|
|
13051
|
+
about?: string | null;
|
|
13052
|
+
email?: string | null;
|
|
13053
|
+
/** Format: uuid */
|
|
13054
|
+
id: string;
|
|
13055
|
+
name?: string | null;
|
|
13056
|
+
phoneNumber?: string | null;
|
|
13057
|
+
photoUrl?: string | null;
|
|
13058
|
+
surname?: string | null;
|
|
13059
|
+
};
|
|
13060
|
+
/**
|
|
13061
|
+
* @deprecated
|
|
13062
|
+
* @description Deprecated. Use customer.user instead.
|
|
13063
|
+
*/
|
|
13064
|
+
userOwner?: {
|
|
13065
|
+
about?: string | null;
|
|
13066
|
+
email?: string | null;
|
|
13067
|
+
/** Format: uuid */
|
|
13068
|
+
id: string;
|
|
13069
|
+
name?: string | null;
|
|
13070
|
+
phoneNumber?: string | null;
|
|
13071
|
+
photoUrl?: string | null;
|
|
13072
|
+
surname?: string | null;
|
|
13073
|
+
};
|
|
13074
|
+
/**
|
|
13075
|
+
* Format: uuid
|
|
13076
|
+
* @deprecated
|
|
13077
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13078
|
+
*/
|
|
13079
|
+
userRefCreator?: string;
|
|
13080
|
+
/**
|
|
13081
|
+
* Format: uuid
|
|
13082
|
+
* @deprecated
|
|
13083
|
+
* @description Deprecated. Use customer.user instead.
|
|
13084
|
+
*/
|
|
13085
|
+
userRefOwner?: string;
|
|
13086
|
+
};
|
|
13087
|
+
};
|
|
13088
|
+
transactionDayPasses: {
|
|
13089
|
+
/** @description Total day pass amount (absolute sum of expiring and permanent). */
|
|
13090
|
+
amount: number;
|
|
13091
|
+
/** @description Per-bucket amounts for charge transactions. */
|
|
13092
|
+
amounts: {
|
|
13093
|
+
/** @description Amount deducted from this balance bucket. */
|
|
13094
|
+
amount: number;
|
|
13095
|
+
/**
|
|
13096
|
+
* Format: date-time
|
|
13097
|
+
* @description Expiration date for expiring balances.
|
|
13098
|
+
*/
|
|
13099
|
+
expirationDate?: string;
|
|
13100
|
+
/**
|
|
13101
|
+
* Format: uuid
|
|
13102
|
+
* @description Subscription associated with expiring balances.
|
|
13103
|
+
*/
|
|
13104
|
+
subscriptionRef?: string;
|
|
13105
|
+
/**
|
|
13106
|
+
* @description Balance bucket type.
|
|
13107
|
+
* @enum {string}
|
|
13108
|
+
*/
|
|
13109
|
+
type: "expiring" | "permanent";
|
|
13110
|
+
}[];
|
|
13111
|
+
/**
|
|
13112
|
+
* @deprecated
|
|
13113
|
+
* @description Deprecated. Use product instead.
|
|
13114
|
+
*/
|
|
13115
|
+
booking?: {
|
|
13116
|
+
/**
|
|
13117
|
+
* Format: uuid
|
|
13118
|
+
* @description Booking id.
|
|
13119
|
+
*/
|
|
13120
|
+
id: string;
|
|
13121
|
+
/** @description Booked resource. */
|
|
13122
|
+
resource: {
|
|
13123
|
+
/**
|
|
13124
|
+
* Format: uuid
|
|
13125
|
+
* @description Resource id.
|
|
13126
|
+
*/
|
|
13127
|
+
id: string;
|
|
13128
|
+
/** @description Resource title. */
|
|
13129
|
+
title: string;
|
|
13130
|
+
};
|
|
13131
|
+
};
|
|
13132
|
+
/**
|
|
13133
|
+
* @deprecated
|
|
13134
|
+
* @description Deprecated. Use customer instead.
|
|
13135
|
+
*/
|
|
13136
|
+
company?: {
|
|
13137
|
+
/**
|
|
13138
|
+
* Format: date-time
|
|
13139
|
+
* @description ISO timestamp of company creation.
|
|
13140
|
+
*/
|
|
13141
|
+
createDate: string;
|
|
13142
|
+
/**
|
|
13143
|
+
* Format: uuid
|
|
13144
|
+
* @description Company id.
|
|
13145
|
+
*/
|
|
13146
|
+
id: string;
|
|
13147
|
+
/**
|
|
13148
|
+
* Format: uuid
|
|
13149
|
+
* @description Location id.
|
|
13150
|
+
*/
|
|
13151
|
+
locationRef: string;
|
|
13152
|
+
/** @description Company logo. */
|
|
13153
|
+
logo?: {
|
|
13154
|
+
/** @description Storage key of the company logo. */
|
|
13155
|
+
key: string;
|
|
13156
|
+
/** @description Public URL of the company logo. */
|
|
13157
|
+
url: string;
|
|
13158
|
+
};
|
|
13159
|
+
/** @description Company metadata. */
|
|
13160
|
+
metadata?: {
|
|
13161
|
+
[key: string]: unknown;
|
|
13162
|
+
};
|
|
13163
|
+
/** @description Internal notes. */
|
|
13164
|
+
notes?: string;
|
|
13165
|
+
/** @description Public logo URL derived from the company website. */
|
|
13166
|
+
publicLogoUrl?: string;
|
|
13167
|
+
/**
|
|
13168
|
+
* Format: uuid
|
|
13169
|
+
* @description Primary subscription id.
|
|
12766
13170
|
*/
|
|
12767
|
-
|
|
12768
|
-
|
|
12769
|
-
|
|
12770
|
-
|
|
12771
|
-
|
|
12772
|
-
|
|
12773
|
-
|
|
12774
|
-
|
|
12775
|
-
|
|
13171
|
+
subscriptionRef: string | null;
|
|
13172
|
+
/** @description Company name. */
|
|
13173
|
+
title: string;
|
|
13174
|
+
};
|
|
13175
|
+
/**
|
|
13176
|
+
* Format: uuid
|
|
13177
|
+
* @deprecated
|
|
13178
|
+
* @description Deprecated. Use customer instead.
|
|
13179
|
+
*/
|
|
13180
|
+
companyRef?: string;
|
|
13181
|
+
/**
|
|
13182
|
+
* Format: date-time
|
|
13183
|
+
* @description ISO timestamp of when the transaction was created.
|
|
13184
|
+
*/
|
|
13185
|
+
createDate: string;
|
|
13186
|
+
/** @description Customer associated with this transaction. */
|
|
13187
|
+
customer: {
|
|
13188
|
+
/**
|
|
13189
|
+
* Format: uuid
|
|
13190
|
+
* @description ID of the company or membership.
|
|
13191
|
+
*/
|
|
13192
|
+
id: string;
|
|
13193
|
+
/** @description Company logo. */
|
|
13194
|
+
logo?: {
|
|
13195
|
+
key: string;
|
|
13196
|
+
url: string;
|
|
12776
13197
|
};
|
|
13198
|
+
/** @description Company name. */
|
|
13199
|
+
title?: string;
|
|
12777
13200
|
/**
|
|
12778
|
-
* @
|
|
12779
|
-
* @
|
|
13201
|
+
* @description Whether the customer is a company or a user.
|
|
13202
|
+
* @enum {string}
|
|
12780
13203
|
*/
|
|
12781
|
-
|
|
13204
|
+
type: "company" | "user";
|
|
13205
|
+
/** @description User details for membership customers. */
|
|
13206
|
+
user?: {
|
|
12782
13207
|
about?: string | null;
|
|
12783
13208
|
email?: string | null;
|
|
12784
13209
|
/** Format: uuid */
|
|
@@ -12788,19 +13213,136 @@ interface components {
|
|
|
12788
13213
|
photoUrl?: string | null;
|
|
12789
13214
|
surname?: string | null;
|
|
12790
13215
|
};
|
|
13216
|
+
};
|
|
13217
|
+
/** @description Transaction description. */
|
|
13218
|
+
description?: string;
|
|
13219
|
+
/**
|
|
13220
|
+
* Format: uuid
|
|
13221
|
+
* @description Unique identifier of the transaction.
|
|
13222
|
+
*/
|
|
13223
|
+
id: string;
|
|
13224
|
+
/**
|
|
13225
|
+
* Format: uuid
|
|
13226
|
+
* @description ID of the organization (location).
|
|
13227
|
+
*/
|
|
13228
|
+
locationRef: string;
|
|
13229
|
+
/**
|
|
13230
|
+
* Format: uuid
|
|
13231
|
+
* @deprecated
|
|
13232
|
+
* @description Deprecated. Use customer instead.
|
|
13233
|
+
*/
|
|
13234
|
+
membershipRef?: string;
|
|
13235
|
+
/**
|
|
13236
|
+
* Format: uuid
|
|
13237
|
+
* @deprecated
|
|
13238
|
+
* @description Deprecated. Use userCreator instead.
|
|
13239
|
+
*/
|
|
13240
|
+
membershipRefCreator?: string;
|
|
13241
|
+
/**
|
|
13242
|
+
* Format: uuid
|
|
13243
|
+
* @description ID of the network.
|
|
13244
|
+
*/
|
|
13245
|
+
networkRef: string;
|
|
13246
|
+
/** @description Product details. */
|
|
13247
|
+
product?: {
|
|
12791
13248
|
/**
|
|
12792
13249
|
* Format: uuid
|
|
12793
|
-
* @
|
|
12794
|
-
* @description Deprecated. Use userCreatedBy instead.
|
|
13250
|
+
* @description ID of the associated booking.
|
|
12795
13251
|
*/
|
|
12796
|
-
|
|
13252
|
+
bookingRef?: string;
|
|
13253
|
+
/** @description Display title of the product. */
|
|
13254
|
+
title: string;
|
|
12797
13255
|
/**
|
|
12798
|
-
*
|
|
12799
|
-
* @
|
|
12800
|
-
* @description Deprecated. Use customer.user instead.
|
|
13256
|
+
* @description Product type.
|
|
13257
|
+
* @enum {string}
|
|
12801
13258
|
*/
|
|
12802
|
-
|
|
13259
|
+
type: "booking";
|
|
13260
|
+
};
|
|
13261
|
+
/**
|
|
13262
|
+
* @deprecated
|
|
13263
|
+
* @description Deprecated.
|
|
13264
|
+
*/
|
|
13265
|
+
refund?: {
|
|
13266
|
+
/** @description Refunded expiring amount. */
|
|
13267
|
+
amount: number;
|
|
13268
|
+
/**
|
|
13269
|
+
* Format: date-time
|
|
13270
|
+
* @description Refund creation timestamp.
|
|
13271
|
+
*/
|
|
13272
|
+
createDate: string;
|
|
13273
|
+
};
|
|
13274
|
+
/** @description Transaction status. */
|
|
13275
|
+
status: string;
|
|
13276
|
+
/**
|
|
13277
|
+
* @description Day pass transaction type.
|
|
13278
|
+
* @enum {string}
|
|
13279
|
+
*/
|
|
13280
|
+
type: "adminAllocation" | "adminCharge" | "booking" | "expiration" | "purchaseAllocation" | "refund" | "subscriptionAllocation" | "subscriptionExpiration";
|
|
13281
|
+
/**
|
|
13282
|
+
* @deprecated
|
|
13283
|
+
* @description Deprecated. Use userOwner instead.
|
|
13284
|
+
*/
|
|
13285
|
+
user?: {
|
|
13286
|
+
about?: string | null;
|
|
13287
|
+
email?: string | null;
|
|
13288
|
+
/** Format: uuid */
|
|
13289
|
+
id: string;
|
|
13290
|
+
name?: string | null;
|
|
13291
|
+
phoneNumber?: string | null;
|
|
13292
|
+
photoUrl?: string | null;
|
|
13293
|
+
surname?: string | null;
|
|
13294
|
+
};
|
|
13295
|
+
/** @description User who created the transaction. */
|
|
13296
|
+
userCreatedBy?: {
|
|
13297
|
+
about?: string | null;
|
|
13298
|
+
email?: string | null;
|
|
13299
|
+
/** Format: uuid */
|
|
13300
|
+
id: string;
|
|
13301
|
+
name?: string | null;
|
|
13302
|
+
phoneNumber?: string | null;
|
|
13303
|
+
photoUrl?: string | null;
|
|
13304
|
+
surname?: string | null;
|
|
13305
|
+
};
|
|
13306
|
+
/**
|
|
13307
|
+
* @deprecated
|
|
13308
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13309
|
+
*/
|
|
13310
|
+
userCreator?: {
|
|
13311
|
+
about?: string | null;
|
|
13312
|
+
email?: string | null;
|
|
13313
|
+
/** Format: uuid */
|
|
13314
|
+
id: string;
|
|
13315
|
+
name?: string | null;
|
|
13316
|
+
phoneNumber?: string | null;
|
|
13317
|
+
photoUrl?: string | null;
|
|
13318
|
+
surname?: string | null;
|
|
12803
13319
|
};
|
|
13320
|
+
/**
|
|
13321
|
+
* @deprecated
|
|
13322
|
+
* @description Deprecated. Use customer.user instead.
|
|
13323
|
+
*/
|
|
13324
|
+
userOwner?: {
|
|
13325
|
+
about?: string | null;
|
|
13326
|
+
email?: string | null;
|
|
13327
|
+
/** Format: uuid */
|
|
13328
|
+
id: string;
|
|
13329
|
+
name?: string | null;
|
|
13330
|
+
phoneNumber?: string | null;
|
|
13331
|
+
photoUrl?: string | null;
|
|
13332
|
+
surname?: string | null;
|
|
13333
|
+
};
|
|
13334
|
+
/**
|
|
13335
|
+
* Format: uuid
|
|
13336
|
+
* @deprecated
|
|
13337
|
+
* @description Deprecated. Use userCreatedBy instead.
|
|
13338
|
+
*/
|
|
13339
|
+
userRefCreator?: string;
|
|
13340
|
+
/**
|
|
13341
|
+
* Format: uuid
|
|
13342
|
+
* @deprecated
|
|
13343
|
+
* @description Deprecated. Use customer.user instead.
|
|
13344
|
+
*/
|
|
13345
|
+
userRefOwner?: string;
|
|
12804
13346
|
};
|
|
12805
13347
|
transaction: {
|
|
12806
13348
|
amount?: number;
|
|
@@ -12892,13 +13434,11 @@ interface components {
|
|
|
12892
13434
|
user?: components["schemas"]["user"];
|
|
12893
13435
|
};
|
|
12894
13436
|
balance: {
|
|
12895
|
-
|
|
12896
|
-
|
|
12897
|
-
|
|
12898
|
-
|
|
12899
|
-
|
|
12900
|
-
subscriptionRef?: string;
|
|
12901
|
-
};
|
|
13437
|
+
allocation?: number;
|
|
13438
|
+
amount?: number;
|
|
13439
|
+
crossLocationUsage?: number;
|
|
13440
|
+
expirationDate?: components["schemas"]["dateSchema"];
|
|
13441
|
+
subscriptionRef?: string;
|
|
12902
13442
|
};
|
|
12903
13443
|
contact: {
|
|
12904
13444
|
/**
|
|
@@ -15008,7 +15548,7 @@ interface components {
|
|
|
15008
15548
|
* Format: uuid
|
|
15009
15549
|
* @description Parent resource id when creating a child resource.
|
|
15010
15550
|
*/
|
|
15011
|
-
parentRef?: string;
|
|
15551
|
+
parentRef?: string | null;
|
|
15012
15552
|
/** @description Membership plan tiers sold for this resource. */
|
|
15013
15553
|
plans?: {
|
|
15014
15554
|
/** @description Whether membership plans can be sold for this resource. */
|
|
@@ -15330,7 +15870,7 @@ interface components {
|
|
|
15330
15870
|
* Format: uuid
|
|
15331
15871
|
* @description Parent resource id when creating a child resource.
|
|
15332
15872
|
*/
|
|
15333
|
-
parentRef?: string;
|
|
15873
|
+
parentRef?: string | null;
|
|
15334
15874
|
/** @description Membership plan tiers sold for this resource. */
|
|
15335
15875
|
plans?: {
|
|
15336
15876
|
/** @description Whether membership plans can be sold for this resource. */
|
|
@@ -23033,6 +23573,47 @@ interface operations {
|
|
|
23033
23573
|
};
|
|
23034
23574
|
};
|
|
23035
23575
|
};
|
|
23576
|
+
getScheduledDayPassesTransactions: {
|
|
23577
|
+
parameters: {
|
|
23578
|
+
query?: {
|
|
23579
|
+
/** @description UUID of the company or membership whose scheduled day pass transactions to list. */
|
|
23580
|
+
customerRef?: string;
|
|
23581
|
+
/** @description Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
23582
|
+
limit?: number;
|
|
23583
|
+
/** @description Token to retrieve the next page of results. */
|
|
23584
|
+
nextPageToken?: string;
|
|
23585
|
+
/** @description UUID of the subscription whose scheduled day pass transactions to list. */
|
|
23586
|
+
subscriptionRef?: string;
|
|
23587
|
+
};
|
|
23588
|
+
header?: {
|
|
23589
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
23590
|
+
"spacebring-network-id"?: string;
|
|
23591
|
+
};
|
|
23592
|
+
path?: never;
|
|
23593
|
+
cookie?: never;
|
|
23594
|
+
};
|
|
23595
|
+
requestBody?: never;
|
|
23596
|
+
responses: {
|
|
23597
|
+
/** @description OK */
|
|
23598
|
+
200: {
|
|
23599
|
+
headers: {
|
|
23600
|
+
[name: string]: unknown;
|
|
23601
|
+
};
|
|
23602
|
+
content: {
|
|
23603
|
+
"application/json": components["schemas"]["getScheduledDayPassesTransactions"];
|
|
23604
|
+
};
|
|
23605
|
+
};
|
|
23606
|
+
/** @description Bad Request */
|
|
23607
|
+
400: {
|
|
23608
|
+
headers: {
|
|
23609
|
+
[name: string]: unknown;
|
|
23610
|
+
};
|
|
23611
|
+
content: {
|
|
23612
|
+
"application/json": components["schemas"]["responseError"];
|
|
23613
|
+
};
|
|
23614
|
+
};
|
|
23615
|
+
};
|
|
23616
|
+
};
|
|
23036
23617
|
getDayPassesTransactions: {
|
|
23037
23618
|
parameters: {
|
|
23038
23619
|
query?: {
|
|
@@ -23116,6 +23697,43 @@ interface operations {
|
|
|
23116
23697
|
};
|
|
23117
23698
|
};
|
|
23118
23699
|
};
|
|
23700
|
+
getDayPassesTransaction: {
|
|
23701
|
+
parameters: {
|
|
23702
|
+
query?: never;
|
|
23703
|
+
header?: {
|
|
23704
|
+
/** @description The id of the network. Required when using bearer token authentication */
|
|
23705
|
+
"spacebring-network-id"?: string;
|
|
23706
|
+
};
|
|
23707
|
+
path: {
|
|
23708
|
+
/** @description The id of the transaction */
|
|
23709
|
+
id: string;
|
|
23710
|
+
};
|
|
23711
|
+
cookie?: never;
|
|
23712
|
+
};
|
|
23713
|
+
requestBody?: never;
|
|
23714
|
+
responses: {
|
|
23715
|
+
/** @description OK */
|
|
23716
|
+
200: {
|
|
23717
|
+
headers: {
|
|
23718
|
+
[name: string]: unknown;
|
|
23719
|
+
};
|
|
23720
|
+
content: {
|
|
23721
|
+
"application/json": {
|
|
23722
|
+
transaction?: components["schemas"]["transactionDayPasses"];
|
|
23723
|
+
};
|
|
23724
|
+
};
|
|
23725
|
+
};
|
|
23726
|
+
/** @description Bad Request */
|
|
23727
|
+
400: {
|
|
23728
|
+
headers: {
|
|
23729
|
+
[name: string]: unknown;
|
|
23730
|
+
};
|
|
23731
|
+
content: {
|
|
23732
|
+
"application/json": components["schemas"]["responseError"];
|
|
23733
|
+
};
|
|
23734
|
+
};
|
|
23735
|
+
};
|
|
23736
|
+
};
|
|
23119
23737
|
getMoneyTransactions: {
|
|
23120
23738
|
parameters: {
|
|
23121
23739
|
query: {
|
|
@@ -23959,9 +24577,11 @@ type Balance = NonNullable<components["schemas"]["balance"]>;
|
|
|
23959
24577
|
/** A CreditTransaction entity as returned by the Spacebring API. */
|
|
23960
24578
|
type CreditTransaction = NonNullable<components["schemas"]["transactionCreditsExpanded"]>;
|
|
23961
24579
|
/** A DayPassTransaction entity as returned by the Spacebring API. */
|
|
23962
|
-
type DayPassTransaction = NonNullable<
|
|
24580
|
+
type DayPassTransaction = NonNullable<components["schemas"]["transactionDayPasses"]>;
|
|
23963
24581
|
/** A MoneyTransaction entity as returned by the Spacebring API. */
|
|
23964
24582
|
type MoneyTransaction = NonNullable<components["schemas"]["transaction"]>;
|
|
24583
|
+
/** A ScheduledTransaction entity as returned by the Spacebring API. */
|
|
24584
|
+
type ScheduledTransaction = NonNullable<operations["getScheduledDayPassesTransactions"]["responses"][200]["content"]["application/json"]["scheduledTransactions"]>[number];
|
|
23965
24585
|
/** Query parameters for `sb.transactions.credits.list()`. */
|
|
23966
24586
|
interface GetCreditsTransactionsQuery {
|
|
23967
24587
|
/** The number of items to return */
|
|
@@ -24019,6 +24639,17 @@ interface GetMoneyTransactionsQuery {
|
|
|
24019
24639
|
/** Token to retrieve the next page of results. */
|
|
24020
24640
|
nextPageToken?: string;
|
|
24021
24641
|
}
|
|
24642
|
+
/** Query parameters for `sb.transactions.dayPasses.scheduled.list()`. */
|
|
24643
|
+
interface GetScheduledDayPassesTransactionsQuery {
|
|
24644
|
+
/** UUID of the company or membership whose scheduled day pass transactions to list. */
|
|
24645
|
+
customerRef?: string;
|
|
24646
|
+
/** Maximum number of transactions per page. Defaults to 25 when omitted or invalid; values above 100 are capped at 100. */
|
|
24647
|
+
limit?: number;
|
|
24648
|
+
/** Token to retrieve the next page of results. */
|
|
24649
|
+
nextPageToken?: string;
|
|
24650
|
+
/** UUID of the subscription whose scheduled day pass transactions to list. */
|
|
24651
|
+
subscriptionRef?: string;
|
|
24652
|
+
}
|
|
24022
24653
|
/** Request body for `sb.transactions.credits.create()`. */
|
|
24023
24654
|
type CreateCreditsTransactionBody = NonNullable<NonNullable<operations["createCreditsTransaction"]["requestBody"]>["content"]["application/json"]["transaction"]>;
|
|
24024
24655
|
/** Request body for `sb.transactions.dayPasses.create()`. */
|
|
@@ -25086,7 +25717,16 @@ declare function createResources(client: Client<paths>, defaults: SpacebringDefa
|
|
|
25086
25717
|
transactions: DayPassTransaction[];
|
|
25087
25718
|
}>;
|
|
25088
25719
|
iterate(query?: Omit<GetDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<DayPassTransaction, void, undefined>;
|
|
25720
|
+
get(id: string, options?: SpacebringRequestOptions): Promise<DayPassTransaction>;
|
|
25089
25721
|
create(transaction: CreateDayPassesTransactionBody, options?: SpacebringRequestOptions): Promise<DayPassTransaction>;
|
|
25722
|
+
scheduled: {
|
|
25723
|
+
list(query?: GetScheduledDayPassesTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
25724
|
+
nextPageToken?: string;
|
|
25725
|
+
scheduledTransactions: ScheduledTransaction[];
|
|
25726
|
+
searchQueryNext?: string;
|
|
25727
|
+
}>;
|
|
25728
|
+
iterate(query?: Omit<GetScheduledDayPassesTransactionsQuery, "nextPageToken">, options?: SpacebringRequestOptions): AsyncGenerator<ScheduledTransaction, void, undefined>;
|
|
25729
|
+
};
|
|
25090
25730
|
};
|
|
25091
25731
|
money: {
|
|
25092
25732
|
list(query: GetMoneyTransactionsQuery, options?: SpacebringRequestOptions): Promise<{
|
|
@@ -25195,4 +25835,4 @@ declare class SpacebringError extends Error {
|
|
|
25195
25835
|
});
|
|
25196
25836
|
}
|
|
25197
25837
|
|
|
25198
|
-
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, 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 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 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 };
|
|
25838
|
+
export { type Activity, type AddEventHostsBody, type AltCurrency, type Application, type ApplyBenefitBody, 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 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 ScheduledTransaction, 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 };
|